API Reference

/webhooks

post
https://api.brevo.com/v3/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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Values to create a webhook

auth
object

Add authentication on webhook url

boolean

To send batched webhooks

string
enum
Defaults to email

channel of webhook

Allowed:
string

Description of the webhook

string

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

events
array of strings
required
  • 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

events*
headers
array of objects

Custom headers to be send with webhooks

headers
string
enum
Defaults to transactional

Type of the webhook

Allowed:
url
required

URL of the webhook

Responses

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