Webhooks

Get a webhook details

get/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

Response

Webhook informations

urlstring url required

URL of the webhook

idinteger required

ID of the webhook

descriptionstring required

Description of the webhook

eventsstring[] required
type'marketing' | 'transactional' required

Type of webhook (marketing or transactional)

createdAtstring required

Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

modifiedAtstring required

Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

batchedboolean

To send batched webhooks

Example response

{
  "url": "http://requestb.in/173lyyx1",
  "id": 654,
  "description": "Webhook triggered on campaign openings",
  "events": [
    "opens,clicks"
  ],
  "type": "marketing",
  "createdAt": "2016-12-01T12:50:00Z",
  "modifiedAt": "2017-05-12T13:15:00Z",
  "batched": true,
  "auth": {
    "type": "bearer",
    "token": "test-auth-token1234"
  },
  "headers": [
    {
      "key": "cf-secret",
      "value": "test-header-value"
    }
  ]
}

Changes

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