Reference of Payloads to be sent for event type Customer.
Webhook List
For information about specific payloads for a given API event type and webhook notification code, just click on the corresponding Webhook Code in the table below.
| Event Type | Event Sub Type | Code | scheduled to be sent whenever... |
|---|---|---|---|
| CUSTOMER | CUSTOMER_CREATED | 2000 | a customer is created. |
| CUSTOMER | CUSTOMER_UPDATED | 2100 | a customer is updated. |
| CUSTOMER | CUSTOMER_ENABLED | 2101 | a customer is enabled. |
| CUSTOMER | CUSTOMER_DISABLED | 2102 | a customer is disabled. |
| CUSTOMER | CUSTOMER_FAILED | 2002 | a customer failed on being created, updated or enabled/disabled.. |
CUSTOMER_CREATED
{
"event_type": "CUSTOMER", /* API Event Type */
"event_type_description": "CUSTOMER_CREATED", /* Event Sub-Type description */
"webhook_notification_code": 2000, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 345, /* Object ID of the API resource created/updated */
"name": "Rolando Martinez", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
CUSTOMER_UPDATED
{
"event_type": "CUSTOMER", /* API Event Type */
"event_type_description": "CUSTOMER_UPDATED", /* Event Sub-Type description */
"webhook_notification_code": 2100, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 345, /* Object ID of the API resource created/updated */
"name": "Rolando Martinez", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
CUSTOMER_ENABLED
{
"event_type": "CUSTOMER", /* API Event Type */
"event_type_description": "CUSTOMER_ENABLED", /* Event Sub-Type description */
"webhook_notification_code": 2101, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 345, /* Object ID of the API resource created/updated */
"name": "Rolando Martinez", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
CUSTOMER_DISABLED
{
"event_type": "CUSTOMER", /* API Event Type */
"event_type_description": "CUSTOMER_DISABLED", /* Event Sub-Type description */
"webhook_notification_code": 2102, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 345, /* Object ID of the API resource created/updated */
"name": "Rolando Martinez", /* Object Name of the API resource created/updated */
"status": "success", /* The status of the action */
}
}
CUSTOMER_FAILED
{
"event_type": "CUSTOMER", /* API Event Type */
"event_type_description": "CUSTOMER_FAILED", /* Event Sub-Type description */
"webhook_notification_code": 2002, /* Webhook notification event code */
"created_at": "2024-07-15 12:34:56", /* The timestamp when the event was created */
"first_sent_at": "2024-07-15 12:36:00", /* The timestamp of first attempt to send the event */
"attempts": 1, /* Attempts made by the webhook */
"account_id": 321, /* Account ID related with the event sent */
"customer_id": 345, /* Customer ID related with the event, if exist. */
"request_id": 12343, /* If exist, our internal request ID related with the event. */
"details": {
"id": 345, /* Object ID of the API resource created/updated */
"status": "failed", /* The status of the action */
"failed_reason": "Inconsistent data", /* If status=failed, a failure code */
"failed_message": "Wrong Email and/or Phone" /* If status=failed, a description of the failure */
}
}