Webhooks

Export all webhook events

This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.

post/webhooks/export

Request

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

Request body

daysinteger

Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

startDatestring

Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate

endDatestring

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

sortstring

Sorting order of records (asc or desc)

type'transactional' | 'marketing' required

Filter the history based on webhook type

event'invalid_parameter' | 'missing_parameter' | 'hardBounce' | 'softBounce' | 'delivered' | 'spam' | 'request' | 'opened' | 'click' | 'invalid' | 'deferred' | 'blocked' | 'unsubscribed' | 'error' | 'uniqueOpened' | 'loadedByProxy' | 'allEvents' required

Filter the history for a specific event type

notifyURLstring required

Webhook URL to receive CSV file link

webhookIdinteger

Filter the history for a specific webhook id

emailstring

Filter the history for a specific email

messageIdinteger

Filter the history for a specific message id. Applicable only for transactional webhooks.

Example request

{
  "days": 7,
  "startDate": "2023-02-13T00:00:00.000+0000",
  "endDate": "2023-02-17T00:00:00.000+0000",
  "sort": "desc",
  "type": "transactional",
  "event": "request",
  "notifyURL": "https://brevo.com",
  "webhookId": 2345,
  "email": "example@brevo.com"
}

Response

Request accepted

processIdinteger required

Id of the process created

Example response

{
  "processId": 78
}

Changes

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