API Reference

/webhooks/{webhookId}

put
https://api.brevo.com/v3/webhooks/

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Id of the webhook

Body Params

Values to update a webhook

auth
object

Add authentication on webhook url

boolean

To send batched webhooks

string

Description of the webhook

string

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

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
headers
array of objects

Custom headers to be send with webhooks

headers
url

URL of the webhook

Responses
204

Webhook updated

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago