API Reference

Customer Updated

wbhk
customers.update
📬

Your system will receive this payload when you create a Subscription with type customers.update

Receive real-time notifications when Customers are updated in your Account. This webhook enables you to synchronize your systems with customer changes, such as when customer information is modified.

📘

Info

The webhook payload contains the customer reference and updated details. Use the Get Customer endpoint to retrieve complete customer information.

⚠️

Warning

Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the redrive policy.

Common use cases include updating your CRM system, triggering notifications, or logging customer changes in your analytics platform.

Payload

Schema for representing customer details.

string

Ref serves as a unique identifier for customer within the (account)[account] (merchant).

string

The unique identifier (AVID) of the merchant's account.

metadata
object

Add additional information associated with the customer like name, location etc. A special mention to the customers/crm/authvia product which can enable a signup form for customers to self sign up and/or add validation checking for each customer created.

appdata
object

A merchant can add extra details for a customer, such as notes, references, secret etc, which are not visible to the customer. This attribute is only deliviered on webhook payloads and returned for API calls to load a customer record.

Response
200

Your system should return a 2xx status to indicate that the data was published successfully. Other statuses will be considered a failure and we will retry later. See the redrive page for more details.

Updated 11 months ago 

LoadingLoading…

Updated 11 months ago