webhooks

Update a 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
put/webhooks/{webhookId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/webhooks/{webhookId}
  • Auth: API key in header api-key

Path parameters

webhookIdinteger required

Id of the webhook

Request body

batchedboolean

To send batched webhooks

descriptionstring

Description of the webhook

domainstring

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

eventsWebhooksWebhookIdPutRequestBodyContentApplicationJsonSchemaEventsItems[]
  • 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

reply

urlstring url

URL of the webhook

Response

Webhook updated

object required

Changes

No recorded changes to this operation across all 1 revision of this API.