Webhooks allows us to communicate companies about different events.
{
"id": "259c5334-b770-4487-871c-60c194b57307",
"events": [
"accepted_transaction"
],
"name": "Webhook transacción aceptada",
"url": "https://example.com/accpted_transaction"
}
Allowed events
The following events are available.
| Event name | Description |
|---|---|
accepted_transaction | This event will be triggered when a payment attempt is successful |
rejected_transaction | This event will be triggered when a payment attempt fails |
subscription_buyer_in_debt | This event will be triggered when a SubscriptionBuyer changes it's status to indebt |
payment_plan_in_debt | This event will be triggered when a PaymentPlan changes it's status to in_debt |
transfer_to_seller | This event will be triggered when Zafepay transfers money to the seller |
payment_plan_ap_enrollment | This event will be triggered each time a buyer enroll an automatic payment method on a payment plan |
subscription_buyer_ap_enrollment | This event will be triggered each time a buyer enroll an automatic payment method on a subscription buyer |
Attributes
The attributes available for a Webhook object are:
| Name | Type | Description |
|---|---|---|
| id | string | Webhook unique identifier. |
| name | string | Name of the webhook. |
| url | string | URL to which the webhook will make the request. |
| events | array of strings | Events to which the webhook is subscribed. |
| secret | string | A unique key assigned to each webhook at creation time. Used to verify that incoming requests were sent by Zafepay. Only shown once when webhook is created. Store it securely. |