Webhooks Integration

Ezypay’s webhooks provide immediate notifications for actions on their platform. It is crucial to set up the following webhooks for all integrations.

https://developer.ezypay.com/docs/webhooks

By following these guidelines, you can maintain secure and efficient communication with Ezypay’s API and ensure timely updates through webhooks.

Important Items

Minimum required events
Ezypay identified these events as critical for integration into your platform. These events ensure you are notified of any changes to customer and billing information. You can also design your business logic around these webhook events to enhance the automation of your platform.

Customer RelatedInvoice Management
customer_createsubscription_created
customer_updatesusbscription_payment_reactivated
payment_method_linkedsubscription_payment_lined
payment_method_replacedinvoice_created
payment_method_validinvoice_paid
payment_method_invalidinvoice_past_due
credit_note_created
credit_note_paid
credit_note_failed
transaction_settled

Note: For partners integrating with the subscription model only.

Parsing Webhook Events
Ensure your platform can parse the JSON format of the webhook events. This is essential for your platform to understand and process the information received. For detailed responses to each event, refer to the Webhook Event Response.

Failed Webhook Events
In the event of a failure to send a webhook, Ezypay will automatically retry to deliver the webhook events.