Webhooks

Update a webhook

put/webhooks/{webhookId}

Request

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

Path parameters

webhookIdinteger required

Id of the webhook

Request body

urlstring url

URL of the webhook

descriptionstring

Description of the webhook

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

domainstring

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

batchedboolean

To send batched webhooks

Example request

{
  "url": "http://requestb.in/173lyyx1",
  "description": "Webhook triggered on contact hardbounce",
  "events": [
    "hardBounce"
  ],
  "domain": "example.com",
  "batched": true,
  "auth": {
    "type": "bearer",
    "token": "test-auth-token1234"
  },
  "headers": [
    {
      "key": "cf-secret",
      "value": "test-header-value"
    }
  ]
}

Response

Webhook updated

Changes

No recorded changes to this operation across all 2 revisions of this API.