Create webhook

post https://api-sandbox.ezypay.com/v2/webhooks

Integrators will use the create Webhook API to provide Ezypay the URL to the weblistener. All events will be delivered to the endpoint provided.

Integrators will provide the list of eventTypes that they will want to received the webhook notification.

Adding security token:
https://developer.ezypay.com/docs/adding-security-token-to-the-webhooks

Body Params

url

string

required

The callback url when an event has occurred.

eventTypes

array of strings

required

List of eventTypes that will trigger a notification when the event occurs. Supported values are: customer_create, customer_update, invoice_created, invoice_past_due, invoice_paid, invoice_batch_created, invoice_batch_processing, invoice_batch_success, invoice_batch_invoice_failed, subscription_create, subscription_cancel, subscription_activate, payment_method_invalid, payment_method_valid, payment_method_linked, payment_method_replaced, payment_method_changed, subscription_payment_reactivate, subscription_payment_stopped, subscription_complete, credit_note_created, credit_note_paid, credit_note_failed, partner_invoice_created, partner_invoice_paid, partner_invoice_past_due

eventTypes*

Headers

merchant

string

required

Merchant ID

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.ezypay.com/v2/webhooks \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
21
 
1
{
2
  "url": https://companyName.net/callback,
3
  "eventTypes": [
4
    "invoice_created",
5
    "customer_create",
6
    "subscription_activate",
7
    "subscription_payment_reactivate",
8
    "payment_method_invalid",
9
    "payment_method_replaced",
10
    "invoice_paid",
11
    "invoice_past_due",
12
    "subscription_create",
13
    "subscription_cancel",
14
    "invoice_batch_created",
15
    "invoice_batch_processing",
16
    "invoice_batch_success",
17
    "invoice_batch_invoice_failed"
18
  ],
19
  "id": "2c4e8865-1e9f-4dcb-88d4-c36f3cc9ea83",
20
  "createdOn": "2019-07-12T06:55:54.526"
21
}

200200

400400