Webhook event
export.failed
The export could not be built.
- Type
export.failed- The object it carries
- the
exportobject - Subscribe with
export.failed,export.*or*
Example payload
The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.
Example payload
{
"id": "evt_9gz6pb8ynwy4gjs6q6px9w0r",
"object": "event",
"livemode": true,
"created": "2026-10-12T08:00:00.000Z",
"type": "export.failed",
"api_version": "2026-10-11",
"data": {
"object": {
"id": "exp_kpvgpbjqmv3kexwyrnp12j8e",
"object": "export",
"livemode": true,
"created": "2026-10-12T08:00:00.000Z",
"type": "orders",
"format": "csv",
"status": "failed",
"filters": {
"created": {
"gte": "2026-09-01T00:00:00.000Z",
"lt": "2026-10-01T00:00:00.000Z"
},
"status": [
"paid",
"overpaid"
]
},
"timezone": "America/Los_Angeles",
"display_currency": "USD",
"row_count": null,
"file": null,
"snapshot_at": "2026-10-12T08:00:00.000Z",
"completed_at": null,
"expires_at": null,
"failure_code": "export_too_large",
"requested_by": {
"type": "api_key",
"id": "key_6e3gg2c6ea176xxdek2nar6v"
}
},
"previous_attributes": {
"status": "running",
"failure_code": null
}
},
"request": {
"id": null,
"idempotency_key": null
},
"pending_webhooks": 1
}Fields of data.object
| Field | In this example |
|---|---|
id | "exp_ |
object | "export" |
livemode | true |
created | "2026-10-12T08: |
type | "orders" |
format | "csv" |
status | "failed" |
filters | An object with created, status |
timezone | "America/Los_Angeles" |
display_currency | "USD" |
row_count | null |
file | null |
snapshot_at | "2026-10-12T08: |
completed_at | null |
expires_at | null |
failure_code | "export_too_large" |
requested_by | An object with type, id |
What each field means is on the page of the export object. data.previous_attributes holds the old values of exactly the fields that changed: here status, failure_code.
Endpoints behind it
Calls that change files and exports. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.