Webhook

Event pushes for human handoff, new messages, conversation closure, tickets, and document processing, plus signature verification and retry rules.

Fill in the webhook URL under "Bot Settings" in the dashboard. Request headers:

HeaderDescription
X-AICS-Event-IdEvent ID; use it to deduplicate
X-AICS-Timestamp / X-AICS-SignatureSignature verification works the same way as the order lookup API

Request body: {"id", "type", "created_at", "data"}.

EventWhen it fires
conversation.handoffHandoff to a human agent (when the handoff method is set to "Push to my system" or "Notify both")
conversation.messageA customer sends a new message in human-agent mode
conversation.closedThe conversation ends (data.conversation.closed_by shows who ended it)
conversation.ratedA customer rates a closed conversation: data.rating, data.comment
ticket.createdA new ticket (including messages left by customers when no agent is online): data.ticket, data.description
ticket.updatedChanges to ticket status, priority, assignee, etc.: data.changes is {字段: [旧, 新]}
ticket.repliedAn agent replies to the customer: data.reply
document.ready / document.failedDocument processing completed or failed

A 2xx response is treated as success. Otherwise, we retry with backoff at 30 seconds, 2 minutes, 10 minutes… up to 12 hours, for a total of 8 attempts. Order is not guaranteed.

Was this page helpful?

Last updated: