API Reference

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
https://api.brevo.com/v3/webhooks/export

Exports webhook event history to CSV format for analysis and reporting.

Use this to:

  • Generate comprehensive webhook event reports
  • Analyze webhook delivery patterns and success rates
  • Export event data for external analysis tools
  • Create historical reports for compliance and auditing
  • Track webhook performance and reliability metrics

Key information returned:

  • Process ID for tracking export completion
  • CSV file will be delivered to specified webhook URL
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

This is a Brevo+ feature.

To have it activated please send us a request and we will activate it for your account.


Body Params

Values to submit for webhooks history

integer

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

string

Filter the history for a specific email

string

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

string
enum
required

Filter the history for a specific event type

integer

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

string
required

Webhook URL to receive CSV file link

string

Sorting order of records (asc or desc)

string

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

string
enum
required

Filter the history based on webhook type

Allowed:
integer

Filter the history for a specific webhook id

Responses

Updated 7 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 7 months ago