webhooks

Create a webhook

Creates a new webhook to receive real-time notifications for specified events.

Use this to:

  • Set up event notifications for transactional or marketing emails
  • Configure webhook endpoints for campaign tracking
  • Enable real-time monitoring of email delivery status
  • Subscribe to contact list changes and updates
  • Implement custom event handling and automation

Key information returned:

  • Created webhook ID and configuration
  • Success confirmation and setup details
post/webhooks

Request

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

Request body

batchedboolean

To send batched webhooks

channel'email' | 'sms'

Channel of the webhook

descriptionstring

Description of the webhook

domainstring

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

eventsWebhooksPostRequestBodyContentApplicationJsonSchemaEventsItems[]

Events triggering the webhook. Required for transactional and marketing types, optional for inbound type (defaults to inboundEmailProcessed). 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, contactUpdated & contactDeleted. Possible values for Inbound type webhook: inboundEmailProcessed.

type'transactional' | 'marketing' | 'inbound'

Type of the webhook

urlstring url required

URL of the webhook

Response

successfully created

idinteger required

ID of the object created

Changes

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