Webhooks

A webhook is an address in your other software that ChatIQ calls the moment something happens, such as a chat starting. It is how TicAte CRM hears about new chats, and how a developer can connect ChatIQ to anything else.

Only owners and admins can add and delete webhooks.

Add a webhook

1. Open Settings and click API & webhooks.
2. Under Webhooks, paste the address into Endpoint URL.
3. Tick the events to send. conversation.started and message.created are ticked to start with.
4. Choose the websites it covers. With none ticked, it covers every website, including any you add later.
5. Click Add webhook.
6. Copy the Signing secret it shows: "copy it now, it won't be shown again." The receiving software uses it to check each call.

The events

• conversation.started: a visitor starts a chat, or your team writes first.
• message.created: a new message, from a visitor or your team. Internal notes are never sent.
• conversation.closed: a chat is closed.
• visitor.identified: a visitor gives their name or email.
• contact.created: a new contact is added.
• rating.received: a chat is given a rating. The chat window does not ask visitors for one yet.

Is it working?

Each webhook in the list shows how its calls are going: "Nothing sent yet — it fires when one of those events happens.", or Last delivered with how many of its calls got through, or Last attempt failed with the reason. Delete removes it.

ChatIQ makes each call once and waits up to 10 seconds for an answer. A call that fails is not repeated, so the receiving software should answer straight away and do any slow work afterwards.

For developers

Each call is a POST with a JSON body, signed in the X-TicAte-Signature header as sha256= followed by the HMAC-SHA256 of the raw body, in hex, using the signing secret. Recalculate it from the body exactly as received and compare before trusting the call.