patch https://examplebaseURL.com/v1/api/apps//inquiry-event-sub
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 - Opened (A new enquiry is incoming) - Handling (An enquiry is being handled) - Closed (An enquiry is closed) - Missed (An enquiry is missed) |
| 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 - CINNOX (An enquiry received in the CINNOX Dashboard) - FACEBOOK (An enquiry received through a created Messager channel) - LINE (An enquiry received through a created LINE channel) - WECHAT (An enquiry received through a created WECHAT channel) - WHATSAPP (An enquiry received through a created WHATSAPP channel) - THIRDPARTY (An enquiry received through a created third party channel) -CHATBOT (An enquiry received through a chatbot) - EMAIL (An enquiry received through a created email channel) - WOZTELL (An enquiry received through a created WOZTELL channel) - INSTAGRAM (An enquiry received through a created Instagram channel) |
| channelOri | String | It indicates an origin of an enquiry. If the channel's value is CINNOX, the value can be - CINNOX (An enquiry's origin is the CINNOX service) - FACEBOOK (An enquiry's origin is Messager) - LINE (An enquiry's origin is LINE) - WECHAT (An enquiry's origin is WeChat) - WHATSAPP (An enquiry's origin is WhatsApp) - THIRDPARTY (An enquiry's origin is a third party) - CHATBOT (An enquiry's origin is a chatbot) - EMAIL (An enquiry's origin is an email) - WOZTELL (An enquiry's origin is WOZTELL) - INSTAGRAM (An enquiry's origin is Instagram) - VirtualNumber (An enquiry's origin is a call from a virtual number) - Directory (An enquiry's origin is Messager) - Weblink (An enquiry's origin is a web link) - Campaign (An enquiry's origin is an SMS campaign) - Unknown (An enquiry's origin is unknown) 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 - STAFF (The staff who handled the enquiry) - PHONE (PSTN Phone) - SIP (SIP Trunk) |
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"
- }