Customer Callbacks

Forward compatibility

While the basic callback structure remains constant:

{
    "integrationID": "string",
    "integrationName": "string",
    "event": {}
}

there are constant additions to channels, including new features and message types, and Clickatell will be adding these to the callbacks as they become available.

Customers are required to implement callback processing in such a way that new event types and additional parameters in an event type do not break callback processing in the customer system.

  • Any HTTP 200 range status code response from the client is considered an acknowledgment that the callback was successful. Anything else, excluding the redirect status code, will be retried.

  • Callback payloads and configurations are different (not backward compatible).

  • In the future, one HTTPS callback request may contain multiple events for efficiency, but currently, batch sizes are always one.

  • The events in callbacks may be out of sequence. Users should look at timestamp fields to determine the order.

  • Timestamps are millisecond unit timestamps.

  • If the customer application does not respond fast enough to HTTP/S callbacks, we will retry the callback. This means they may experience duplicate callbacks (due to the retries).

  • Customers can configure a callback URL for status event callbacks and another URL for MO messages. This helps to maintain low-latency conversations by splitting the events.

One API reply callback

Example of a customer's One Api reply callback

post
Body
integrationIdstringOptional
integrationNamestringOptional
Responses
200

Success

No content

post
/client-callback/one-api-reply
200

Success

No content

One API status callback

Example of a customer's One Api status callback

post
Body
integrationIdstringOptional
integrationNamestringOptional
Responses
200

Success

No content

post
/client-callback/one-api-status
200

Success

No content

Last updated