Accounts and SettingsWebhooks

Update Webhook

Updates an existing webhook configuration and event subscriptions. Use this to: - Modify webhook event subscriptions and triggers - Update webhook URL and endpoint configuration - Change authentication settings and credentials - Adjust custom headers and request parameters - Enable or disable specific webhook events Key information returned: - Success confirmation of webhook updates

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

Request

Values to update a webhook
authobjectOptional
Add authentication on webhook url
batchedbooleanOptional
To send batched webhooks
descriptionstringOptional
Description of the webhook
domainstringOptional

Inbound domain of webhook, used in case of event type inbound

eventslist of enumsOptional
- Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`
headerslist of objectsOptional
Custom headers to be send with webhooks
urlstringOptionalformat: "url"
URL of the webhook

Response

Webhook updated

Errors