Skip to content
Documentation

Agent reply (API channel)

When an agent replies to a conversation on the API channel, ClickFix sends a POST with this body to the URL configured on the channel. The request carries X-ClickFix-Timestamp, X-ClickFix-Signature (the signing method above) and Idempotency-Key (the message UUID); process every key only once. Return 2xx after the message is stored durably. Temporary failures are retried with increasing delays; 4xx responses other than 408 and 429 count as permanent failures.

Header Parameters

X-ClickFix-Timestamp*string

Unix seconds

X-ClickFix-Signature*string

sha256= followed by hex HMAC-SHA256

Idempotency-Key*string
Formatuuid

Request Body

application/json
  1. body

JSON posted to the organization's public webhook URL with timestamped HMAC and Idempotency-Key.

id*string
Formatuuid
conversation_id*string
Formatuuid
recipient_id*string
text*string
thread_id*string
reply_to*string

Response Body

Durably accepted, including duplicate id

Example Requests
POST/apiChannelReply

JSON posted to the organization's public webhook URL with timestamped HMAC and Idempotency-Key.

Request Body
application/json
{  "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",  "conversation_id": "8f0e5c2a-6b1d-4f3a-9c7e-2d4b6a8c0e1f",  "recipient_id": "customer-42",  "text": "Your order ships today.",  "thread_id": "msg-1001",  "reply_to": "msg-1001"}
Header Parameters
{  "X-ClickFix-Timestamp": "string",  "X-ClickFix-Signature": "string",  "Idempotency-Key": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}