Skip to content
API Reference
/
/
Sending Event File Ready

Sending Event File Ready
Webhook

Request

Sent when a generated sending event file is ready for download.

Headers
X-Connect-Signaturestringrequired

HMAC SHA-256 signature of the webhook request. It is calculated with the webhook secret over the value ${X-Connect-Timestamp}.${rawRequestBody}.

X-Connect-Timestampinteger, (int64)required

Unix timestamp, in seconds, used when calculating the webhook signature.

X-Connect-Event-Idstringrequired

Unique identifier of the webhook event. This is the same value as data.eventId in the payload.

Bodyapplication/jsonrequired
eventTypestringrequired
Value:"sending.event.file.ready"
timestampstring, (date-time)required
Example:"2025-04-01T10:11:34.518Z"
versionstringrequired
Example:"1"
dataobject(SendingEventFileReadyWebhookEventDataDto)required
Payload
{
  "eventType": "sending.event.file.ready",
  "timestamp": "2025-04-01T10:11:34.518Z",
  "version": "1",
  "data": {
    "eventId": "01KN4017Y7T44D4V0EY21RHFZX",
    "companyId": "01KN4017Y7T44D4V0EY21RHFZX",
    "jobId": "01KN4017Y7T44D4V0EY21RHFZX",
    "sendingEventId": "01KN4017Y7T44D4V0EY21RHFZX-01KN4017Y7T44D4V0EY21RHFZX",
    "departmentId": "01KN4017Y7T44D4V0EY21RHFZX",
    "fileType": "SUBMISSION_REPORT",
    "fileReference": "01KN4017Y7T44D4V0EY21RHFZX-SUBMISSION_REPORT"
  }
}

Responses

Return a 2xx response to acknowledge successful receipt.