Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 1.99 KB

ExportWebhooksHistory.md

File metadata and controls

50 lines (41 loc) · 1.99 KB

ExportWebhooksHistory

Properties

Name Type Description Notes
days Integer Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' [optional]
startDate String Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate [optional]
endDate String Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate [optional]
sort String Sorting order of records (asc or desc) [optional]
type TypeEnum Filter the history based on webhook type
event EventEnum Filter the history for a specific event type
notifyURL String Webhook URL to receive CSV file link
webhookId Integer Filter the history for a specific webhook id [optional]
email String Filter the history for a specific email [optional]
messageId Integer Filter the history for a specific message id. Applicable only for transactional webhooks. [optional]

Enum: TypeEnum

Name Value
TRANSACTIONAL "transactional"
MARKETING "marketing"

Enum: EventEnum

Name Value
INVALID_PARAMETER "invalid_parameter"
MISSING_PARAMETER "missing_parameter"
HARDBOUNCE "hardBounce"
SOFTBOUNCE "softBounce"
DELIVERED "delivered"
SPAM "spam"
REQUEST "request"
OPENED "opened"
CLICK "click"
INVALID "invalid"
DEFERRED "deferred"
BLOCKED "blocked"
UNSUBSCRIBED "unsubscribed"
ERROR "error"
UNIQUEOPENED "uniqueOpened"
LOADEDBYPROXY "loadedByProxy"
ALLEVENTS "allEvents"