Webhook APIs

Get Webhook

Retrieve the configuration details of a specific webhook, including the event URLs and custom headers. This API returns all the events (e.g., delivered, open, click) associated with the webhook, along with their respective callback URLs. Note: When using a master account API key, you can fetch webhook details for a subaccount by specifying the subaccount's username in the on-behalf-of header.

get/webhooks/{id}

Path parameters

idinteger required

ID of the webhook to retrieve.

Headers

on-behalf-ofstring
Example:subaccount1

Allows a master account to retrieve webhooks configured by a subaccount, by specifying the subaccount's username.

Response

Webhook details retrieved successfully

webhook_idinteger required
eventsEvents required— unresolved $ref
headersobject

Changes