Response Format
Parameter | Type | Description |
---|---|---|
enabled | Boolean | The value must be true or false. It is "true" when the subscription is successful, while it is "false" when the subscription fails. |
url | String | The webhook URL. In access to this URL, you can receive an equiry notification in CINNOX. |
updatedAt | String | The updated date and time of this subscription. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
Notification of Enquiry
You can receive the an enquiry notification after subscribing to this event.
Notification Details | Type | Description |
---|---|---|
status | String | It indicates the status of the enquiry. The values can be
|
serviceId | String | The service ID in CINNOX. |
displayCaseNumber | String | The Enquiry ID displayed in the CINNOX Dashboard. |
eid | String | The record ID of the enquiry. |
type | String | The value must be "inquiry". |
channel | String | It indicates where the enquiry is received in CINNOX. The value can be
|
channelOri | String | It indicates an origin of an enquiry. If the channel's value is CINNOX, the value can be
If the channel's value is not CINNOX, the value must be Channel. |
socialId | String | The ID of the social channel through which the enquiry is received in CINNOX. If the enquiry's origin is not Messager, LINE, WhatsApp, WOZTELL or Instagram, an empty value is shown. |
date | String | The date and time of the enquiry. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
destination | String | The ID of the destination which can be a service group, chatbot or IVR. |
destinationTypes | String | The destination types. It can be
|
Webhook URL Requirement
The webhook URL needs to be verified. After that, you will get a POST request with an Action and are required to set the response in JSON Response format as shown below:
Note that the JsonResponse result is JSON encoding of the Action Endpoint Response.
Action Endpoint Request {
- Challenge string json:"challenge"
- }
Action Endpoint Response {
- Challenge string json:"challenge"
- }
Json Response {
- Code int json:"code"
- Result json.RawMessage json:"result"
- }