Update a webhook

put https://api.brevo.com/v3/webhooks/{webhookId}

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

webhookId

int64

required

Id of the webhook

Body Params

Values to update a webhook

url

URL of the webhook

description

string

Description of the webhook

events

array of strings

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`

events

domain

string

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

batched

boolean

Batching configuration of the webhook, we send batched webhooks if its true

auth

object

Authentication header to be send with the webhook requests

headers

array of objects

headers

Responses

204

Webhook updated

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.brevo.com/v3/webhooks/webhookId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

sent OR request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed

spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered

inboundEmailProcessed

400bad request

404Webhook ID not found

`sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed`

`spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered`

`inboundEmailProcessed`