POST /webhooks

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

Servers

https://api.brevo.com/v3

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
`channel`	String	No	channel of webhook Valid values: `"email"` `"sms"` Default value: "email"
`description`	String	No	Description of the webhook
`url`	String	Yes	URL of the webhook
`batched`	Boolean	No	To send batched webhooks
`events[]`	Array	Yes	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` - Possible values for type Transactional and channel SMS `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`, `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for type Marketing channel SMS #### `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`, `subscribe`,`skip`
`type`	String	No	Type of the webhook Valid values: `"inbound"` `"transactional"` `"marketing"` Default value: "transactional"
`domain`	String	No	Inbound domain of webhook, required 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

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.