{
"event": "interactions.send",
"time": "2025-01-01T20:00:00.000Z",
"data": {
"type": "LETTER",
"id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
"letterFileId": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"templateId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
}
}Webhooks
Interaction sent
Notifies when an interaction has been sent.
WEBHOOK
interactions.send
{
"event": "interactions.send",
"time": "2025-01-01T20:00:00.000Z",
"data": {
"type": "LETTER",
"id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
"letterFileId": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"templateId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
}
}Headers
Sent with every delivery so the receiver can verify the request really comes from Debbie. The token is issued when the webhook is created — compare it with the stored value and reject deliveries that do not match.
Body
application/json
Webhook payload
Event "interactions.send"
Example:
"interactions.send"
Event dispatch time
Example:
"2025-01-01T20:00:00.000Z"
Data of the event
Show child attributes
Show child attributes
Example:
{
"type": "LETTER",
"id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
"letterFileId": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"templateId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
}