Update a webhook

Update the details of a specific webhook.

Request​

Path Parameters
Path Parameters

The ID of the webhook.

Header Parameters
Header Parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

info

For more information, see: Authentication

Request body
Body object

Possible length: <= 2000 characters

Your webhook's URL to which event notifications will be sent.

Must be a valid HTTP or HTTPS URL, capable of receiving POST requests.

caution

Restrictions:

  • Max length of url string: 2000
  • Only valid http:// or https:// domains are accepted
  • Domain cannot be localhost or IP address

Possible values: [ORDER_COMPLETED, ORDER_AUTHORISED, ORDER_CANCELLED, ORDER_PAYMENT_AUTHENTICATED, ORDER_PAYMENT_DECLINED, ORDER_PAYMENT_FAILED, PAYOUT_INITIATED, PAYOUT_COMPLETED, PAYOUT_FAILED, DISPUTE_ACTION_REQUIRED, DISPUTE_UNDER_REVIEW, DISPUTE_WON, DISPUTE_LOST]
Possible number of items: non-empty

List of event types that the webhook is configured to listen to.

Each event is related to status changes of a specific object in the Merchant API:

ObjectEvent types
Order
  • ORDER_COMPLETED
  • ORDER_AUTHORISED
  • ORDER_CANCELLED
Payment
  • ORDER_PAYMENT_AUTHENTICATED
  • ORDER_PAYMENT_DECLINED
  • ORDER_PAYMENT_FAILED
Payout
  • PAYOUT_INITIATED
  • PAYOUT_COMPLETED
  • PAYOUT_FAILED
Dispute
  • DISPUTE_ACTION_REQUIRED
  • DISPUTE_UNDER_REVIEW
  • DISPUTE_WON
  • DISPUTE_LOST

Response​

OK

Response body
Body object

The ID of the webhook.

Possible length: <= 2000 characters

Your webhook's URL to which event notifications will be sent.

Must be a valid HTTP or HTTPS URL, capable of receiving POST requests.

caution

Restrictions:

  • Max length of url string: 2000
  • Only valid http:// or https:// domains are accepted
  • Domain cannot be localhost or IP address

Possible values: [ORDER_COMPLETED, ORDER_AUTHORISED, ORDER_CANCELLED, ORDER_PAYMENT_AUTHENTICATED, ORDER_PAYMENT_DECLINED, ORDER_PAYMENT_FAILED, PAYOUT_INITIATED, PAYOUT_COMPLETED, PAYOUT_FAILED, DISPUTE_ACTION_REQUIRED, DISPUTE_UNDER_REVIEW, DISPUTE_WON, DISPUTE_LOST]
Possible number of items: non-empty

List of event types that the webhook is configured to listen to.

Each event is related to status changes of a specific object in the Merchant API:

ObjectEvent types
Order
  • ORDER_COMPLETED
  • ORDER_AUTHORISED
  • ORDER_CANCELLED
Payment
  • ORDER_PAYMENT_AUTHENTICATED
  • ORDER_PAYMENT_DECLINED
  • ORDER_PAYMENT_FAILED
Payout
  • PAYOUT_INITIATED
  • PAYOUT_COMPLETED
  • PAYOUT_FAILED
Dispute
  • DISPUTE_ACTION_REQUIRED
  • DISPUTE_UNDER_REVIEW
  • DISPUTE_WON
  • DISPUTE_LOST
Was this page helpful?