Values to submit for webhooks history
Request body which must comply to the following JSON Schema:
{
"oneOf" : [ {
"required" : [ "event", "notifyURL", "type" ],
"type" : "object",
"properties" : {
"days" : {
"type" : "integer",
"description" : "Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_",
"example" : 7
},
"startDate" : {
"type" : "string",
"description" : "Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate",
"example" : "2023-02-13"
},
"endDate" : {
"type" : "string",
"description" : "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate",
"example" : "2023-02-17"
},
"sort" : {
"type" : "string",
"description" : "Sorting order of records (asc or desc)",
"example" : "desc"
},
"type" : {
"type" : "string",
"description" : "Filter the history based on webhook type",
"example" : "transactional",
"enum" : [ "transactional", "marketing" ]
},
"event" : {
"type" : "string",
"description" : "Filter the history for a specific event type",
"example" : "request",
"enum" : [ "invalid_parameter", "missing_parameter", "hardBounce", "softBounce", "delivered", "spam", "request", "opened", "click", "invalid", "deferred", "blocked", "unsubscribed", "error", "uniqueOpened", "loadedByProxy", "allEvents" ]
},
"notifyURL" : {
"type" : "string",
"description" : "Webhook URL to receive CSV file link",
"example" : "https://brevo.com"
},
"webhookId" : {
"type" : "integer",
"description" : "Filter the history for a specific webhook id",
"example" : 2345
},
"email" : {
"type" : "string",
"description" : "Filter the history for a specific email",
"example" : "example@brevo.com"
},
"messageId" : {
"type" : "integer",
"description" : "Filter the history for a specific message id. Applicable only for transactional webhooks."
}
}
} ]
}
