Skip to main content

Messaging Webhooks

The collectAI messaging webhooks enable your system to take over the actual message sending. In order to achieve this the platform informs you about the fact that it wants to send a message to one of your customers.

Data structure

All message events that can occur will have the same data structure defined below.

PayloadDescription
claimIdThe unique claim identifier used by collectAI
merchantIdThe merchant id the claim belongs to
messageReferenceIdThe unique message identifier. Can be used in the Messages API to retrieve the details and content.

Example request

POST /your-url HTTP/1.1

Body
{
"claimId": 54321,
"merchantId": 1,
"messageReferenceId": "00000000-0000-0000-0000-000000000000"
}