Create/Edit/Delete External Contact Event Subscription

Response Format

enabledBooleanThe value must be true or false. It is "true" when the subscription is successful, while it is "false" when it fails.
urlStringThe webhook URL. In access to this URL, you can receive an External Contact Event Notification in CINNOX.


Notification of External Contact Event

After subscribing to this event, you can receive a notification once the external contact is created, edited, or deleted.

Notification DetailsTypeDescription
typeStringThe value must be "message".
challengeString(Internal Use)
message.typeStringThe value must be "contact".
message.statusStringThe value can be
- "create" when the external contact was created.
- "edit" when the existing external contact was edited.
- "delete" when the existing external contact was deleted.
message.serviceIdStringThe Service ID.
message.fullNameStringThe full name of the external contact.
message.idStringThe ID of the external contact.



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.

+ Challenge string json:"challenge"

+ }

Action Endpoint Response {

+ Challenge string json:"challenge"

+ }

Json Response {

+ Code int json:"code"

+ Result json.RawMessage json:"result"

+ }