Skip to main content
GET
Query

Query

This endpoint allows querying the registered webhook URLs and the events each one receives. Filtering can only be done by account.
  • If account_id is provided, only the webhooks of that account will be returned
  • If account_id is omitted, the webhooks of your merchant and of all its subaccounts will be returned, ordered by account

Query Parameters

integer
ID of the account whose webhooks will be returned: your own merchant or one of its subaccounts.When omitted, the response includes the webhooks of your merchant and of every subaccount you have access to.If the account does not exist or is not linked to your merchant, the request fails with 422 and the invalid_account code.Example: 4521

Response

Returns an array of webhook objects.
The same URL can be registered on your merchant and on each subaccount, so a webhook is identified by the pair account_id + url. To update or remove a webhook returned here, send the same account_id along with the url.
Only the webhooks registered on each account are listed. A subaccount without its own webhook for an event uses the main account’s webhook for that event, which appears only under the main account. See Subaccounts without a webhook.
array
Array of webhook objects

Request Example