Subscribe to webhook events

In order to add a webhook, you must first decide the type of events you want to subscribe to:

Once you know the type of events that you want your webhook to receive, you must register the receiving URL:

 POST /v1/webhooks HTTP/1.1
 Content-Type: application/json
 {
    "item": "ticket",
    "url": "https://some.example/endpoint"
    "secret": "SomeRandomString"
 }
 

The response to this call will be the uuid of the webhook that can update or even delete it.

The verification consists of an empty GET request to the specified URL, with two relevant headers:

• "X-Hook-Signature": This header contains the previously specified secret.
• "X-Inbenta-Challenge": This contains a random string.

In order to complete the verification successfully, the request is expected to return:

• HTTP code: 200
• Body: The content of the "X-Inbenta-Challenge" header as plain text

Receive webhook events

The system always sends a list of webhook events. It can contain one or multiple webhook events and it always groups objects in batches as much as possible to reduce the number of requests .
Each webhook event has the following structure:

 {
    "id": integer,
    "item": string ["alert","ticket","reply","user","media","classification"],
    "action": string ["add","update","remove"],
    "timestamp": integer,
    "actor": integer,
    "parent": integer|null
 }
 

Example: Creating a new classification

 {
    "id": 123, // The id of the created classification
    "item": "classification",
    "action": "add",
    "timestamp": 1524149939,
    "actor": 123, // Timestamp of the creation of the classification
    "parent": 5 // The id of the parent classification
 }
 

Update/Delete webhook subscriptions

You can retrieve a list of all the active webhooks:

 GET /v1/webhooks HTTP/1.1
     Accept: application/json
 {
 }
 

You can update any webhook field at any time using its id:

 PUT /v1/webhooks/{id} HTTP/1.1
 Content-Type: application/json
 {
    "item": "ticket",
    "url": "https://some.example/endpoint"
    "secret": "SomeRandomString"
 }
 

If a webhook is no longer necessary, you can delete it instantly using its id:

 DELETE /v1/webhooks/{id} HTTP/1.1
 Accept: application/json
 {
 }
 

Annex

The following table presents a summary of which endpoint produces a webhook, depending on the item and subscribed action.