Accounts and SettingsWebhooks

Get Webhook

Retrieves detailed information about a specific webhook configuration. Use this to: - Get complete webhook configuration and settings - Check webhook event subscriptions and triggers - Review authentication and security settings - Verify webhook URL and custom headers - Access webhook creation and modification history Key information returned: - Complete webhook details and configuration - Event types and channel subscriptions - Authentication credentials and methods - Custom headers and request settings - Webhook status and activity information

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

webhookIdlongRequired
Id of the webhook

Response

Webhook informations
createdAtstring

Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

descriptionstring
Description of the webhook
eventslist of strings
idlong
ID of the webhook
modifiedAtstring

Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

typeenum

Type of webhook (marketing or transactional)

Allowed values:
urlstringformat: "url"
URL of the webhook
authobject or null
Authentication header to be send with the webhook requests
batchedboolean or null
Batching configuration of the webhook, we send batched webhooks if its true
channelenum or nullDefaults to email
channel of webhook
Allowed values:
headerslist of objects or null

Errors