PUT /webhooks/{webhookId}

Updates an existing webhook configuration and event subscriptions.

Use this to:

Key information returned:

Servers

Path parameters

Name Type Required Description
webhookId Integer Yes

Id of the webhook

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
auth Object No

Add authentication on webhook url

auth.token String No

Webhook authentication token

auth.type String No

Type of authentication

description String No

Description of the webhook

url String No

URL of the webhook

batched Boolean No

To send batched webhooks

events[] Array No
  • 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

domain String No

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

headers[] Array No

Custom headers to be send with webhooks

headers[].key String No

Header key name

headers[].value String No

Header value

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.