Data export failed
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of data export-related webhook event.
dataExportIdstring, <= 50 characters
ID of the data export.
Example:"exp_0YVCNQ2C1AD1RA3HXKP492GNZB"
fileIdstring or null, <= 50 characters

ID of the data export file. This value is null if the export failed.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
recordCountinteger

Total number of records in the export, excluding the header row. This value is 0 if the export failed.

Example:1500
statusstring

Status of the data export. This webhook is sent only when the data export reaches a terminal status. This value is never pending, queued, or processing.

Enum:"completed""failed"
failureReasonstring or null(DataExportFailureReason)read-only

Reason the export failed, if the export status is failed.

Enum ValueDescription
record-limit-exceeded
Export exceeded the maximum number of records allowed for a single export.
max-retries-reached
Export failed after the maximum number of retry attempts.
creator-access-revoked
User who created the export no longer has permission to read the exported resource.
eventTypestring
Type of event that triggered the webhook.
Enum:"data-export-completed""data-export-failed"
_embeddedobject
Embedded objects related to the data export event.
_linksArray of objects
Links to related resources.
POST
data-export-failed
Payload
{
  "dataExportId": "exp_0YVCNQ2C1AD1RA3HXKP492GNZB",
  "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
  "recordCount": 1500,
  "status": "completed",
  "failureReason": "record-limit-exceeded",
  "eventType": "data-export-completed",
  "_embedded": {
    "dataExport": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.