Skip to content
Dixa API/
/
Webhook Subscription

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Webhook Subscription

Request

Get a Webhook Subscription by ID.

Security
ApiKeyAuth
Path
webhookSubscriptionIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks/{webhookSubscriptionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The Webhook Subscription

Bodyapplication/json
dataobject(WebhookSubscription)required
data.​idstring(uuid)required

The Webhook Subscription ID

data.​namestringrequired

The Webhook Subscription name

data.​subscribedEventsArray of stringsunique

The set of events this Webhook Subscription is subscribed to

data.​urlstringrequired

URL of the server that the webhook request should be sent to

data.​headersobject(Webhook_Headers_Map_String_String)required

The headers that will be added to the webhook request

data.​headers.​property name*stringadditional property
data.​secretKeystringrequired

Dixa generated secret key, used to sign the requests

data.​enabledbooleanrequired

Defines whether this Webhook Subscription is enabled or disabled

data.​createdAtstring(date-time)required

Date when this Webhook Subscription was created

data.​createdBystring(uuid)required

The ID of the user who created this Webhook Subscription

data.​updatedAtstring(date-time)required

Date when this Webhook Subscription was last updated

data.​updatedBystring(uuid)required

The ID of the user who last updated this Webhook Subscription

data.​filtersobject(Map_WebhookEventType_Filters)
Response
application/json
{
  "data": {
    "id": "cb452b81-6748-40ab-af85-6559b371bc5d",
    "name": "Dashboard Integration",
    "subscribedEvents": [ … ],
    "url": "https://example.webhook/dashboard_integration",
    "headers": { … },
    "secretKey": "4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc",
    "enabled": true,
    "createdAt": "2023-08-01T09:30:15Z",
    "createdBy": "e979cc3b-17b2-4850-b049-13c758763d1c",
    "updatedAt": "2023-08-02T15:09:30Z",
    "updatedBy": "64b777c3-eb82-49fb-bb3e-294afb5d840c",
    "filters": { … }
  }
}

Delete Webhook Subscription

Request

Delete a Webhook Subscription.

Security
ApiKeyAuth
Path
webhookSubscriptionIdstring(uuid)required
curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks/{webhookSubscriptionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The Webhook Subscription was successfully deleted

Response
No content

Patch Webhook Subscription

Request

Patch a Webhook Subscription.

Security
ApiKeyAuth
Path
webhookSubscriptionIdstring(uuid)required
Bodyapplication/jsonrequired

The Webhook Subscription fields to be patched

namestring

The Webhook Subscription name

eventsArray of stringsunique

The set of events this Webhook Subscription subscribes to. Allowed values: [ConversationPending, AgentUnbannedEnduser, ConversationMessageAdded, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]

urlstring

URL of the server that the webhook request should be sent to

authorizationBasicAuth (object) or NoAuth (object) or TokenAuth (object)(WebhookAuthorization)

Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(<username>:<password>)', Token auth, added as 'Bearer <token value>', or no auth

One of:

Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(<username>:<password>)', Token auth, added as 'Bearer <token value>', or no auth

customHeadersobject(Map_String)
enabledboolean

Defines whether this Webhook Subscription is enabled or disabled

filtersobject(Map_WebhookEventType_Filters)
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks/{webhookSubscriptionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New name",
    "events": [
      "ConversationNoteAdded"
    ],
    "authorization": {
      "value": "eyDoiGciOqGYUzI1NiJ4.eyJ0eQJRUapoYXBpIiwib4JxA5lkIjoiNTVmMmE6MmItYjU4NF33MDMxLTk2NTktOTE2M.qPoOZoQYDn4rn-akaLmVFka15JAV7TF6QT8UHOUTIy0",
      "_type": "TokenAuth"
    },
    "customHeaders": {
      "X-Automation-Webhook-Token": "<TOKEN>",
      "X-Example-Header": "ExampleValue"
    },
    "filters": {
      "Conversation": {
        "strategy": "All",
        "conditions": [
          {
            "field": "InitialChannel",
            "values": [
              "email",
              "pstn_phone"
            ],
            "_type": "IsOneOf"
          },
          {
            "field": "QueueId",
            "values": [
              "f0475e4c-64ae-4c8e-8644-4ed10dc8d752"
            ],
            "_type": "IsNotOneOf"
          }
        ],
        "_type": "CombinedFilters"
      }
    }
  }'

Responses

The patched Webhook Subscription

Bodyapplication/json
dataobject(WebhookSubscription)required
data.​idstring(uuid)required

The Webhook Subscription ID

data.​namestringrequired

The Webhook Subscription name

data.​subscribedEventsArray of stringsunique

The set of events this Webhook Subscription is subscribed to

data.​urlstringrequired

URL of the server that the webhook request should be sent to

data.​headersobject(Webhook_Headers_Map_String_String)required

The headers that will be added to the webhook request

data.​headers.​property name*stringadditional property
data.​secretKeystringrequired

Dixa generated secret key, used to sign the requests

data.​enabledbooleanrequired

Defines whether this Webhook Subscription is enabled or disabled

data.​createdAtstring(date-time)required

Date when this Webhook Subscription was created

data.​createdBystring(uuid)required

The ID of the user who created this Webhook Subscription

data.​updatedAtstring(date-time)required

Date when this Webhook Subscription was last updated

data.​updatedBystring(uuid)required

The ID of the user who last updated this Webhook Subscription

data.​filtersobject(Map_WebhookEventType_Filters)
Response
application/json
{
  "data": {
    "id": "cb452b81-6748-40ab-af85-6559b371bc5d",
    "name": "New name",
    "subscribedEvents": [ … ],
    "url": "https://example.webhook/dashboard_integration",
    "headers": { … },
    "secretKey": "4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc",
    "enabled": true,
    "createdAt": "2023-08-01T09:30:15Z",
    "createdBy": "e979cc3b-17b2-4850-b049-13c758763d1c",
    "updatedAt": "2023-08-02T15:09:30Z",
    "updatedBy": "64b777c3-eb82-49fb-bb3e-294afb5d840c",
    "filters": { … }
  }
}

List all Webhook Subscriptions

Request

List of all Webhook Subscriptions in an organization.

Security
ApiKeyAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The List of Webhook Subscriptions

Bodyapplication/json
dataArray of objects(WebhookSubscription)
Response
application/json
{
  "data": [
    { … }
  ]
}

Create Webhook Subscription

Request

Create a Webhook Subscription.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The Webhook Subscription to be created

namestringrequired

The Webhook Subscription name

eventsArray of stringsunique

The set of events this Webhook Subscription subscribes to. Allowed values: [ConversationPending, AgentUnbannedEnduser, ConversationMessageAdded, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]

urlstringrequired

URL of the server that the webhook request should be sent to

authorizationBasicAuth (object) or NoAuth (object) or TokenAuth (object)(WebhookAuthorization)required

Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(<username>:<password>)', Token auth, added as 'Bearer <token value>', or no auth

One of:

Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(<username>:<password>)', Token auth, added as 'Bearer <token value>', or no auth

authorization.​usernamestringrequired
authorization.​passwordstringrequired
customHeadersobject(Map_String)required
customHeaders.​property name*stringadditional property
enabledboolean

Defines whether this Webhook Subscription is enabled or disabled. Default is true

filtersobject(Map_WebhookEventType_Filters)
curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Dashboard Integration",
    "events": [
      "ConversationCreated",
      "ConversationClosed"
    ],
    "url": "https://example.webhook/dashboard_integration",
    "authorization": {
      "username": "webhook_user",
      "password": "webhook_password",
      "_type": "BasicAuth"
    },
    "customHeaders": {
      "X-Automation-Webhook-Token": "<TOKEN>",
      "X-Example-Header": "ExampleValue"
    },
    "enabled": true,
    "filters": {
      "Conversation": {
        "strategy": "All",
        "conditions": [
          {
            "field": "InitialChannel",
            "values": [
              "email",
              "pstn_phone"
            ],
            "_type": "IsOneOf"
          },
          {
            "field": "QueueId",
            "values": [
              "f0475e4c-64ae-4c8e-8644-4ed10dc8d752"
            ],
            "_type": "IsNotOneOf"
          }
        ],
        "_type": "CombinedFilters"
      }
    }
  }'

Responses

The created Webhook Subscription

Bodyapplication/json
dataobject(WebhookSubscription)required
data.​idstring(uuid)required

The Webhook Subscription ID

data.​namestringrequired

The Webhook Subscription name

data.​subscribedEventsArray of stringsunique

The set of events this Webhook Subscription is subscribed to

data.​urlstringrequired

URL of the server that the webhook request should be sent to

data.​headersobject(Webhook_Headers_Map_String_String)required

The headers that will be added to the webhook request

data.​headers.​property name*stringadditional property
data.​secretKeystringrequired

Dixa generated secret key, used to sign the requests

data.​enabledbooleanrequired

Defines whether this Webhook Subscription is enabled or disabled

data.​createdAtstring(date-time)required

Date when this Webhook Subscription was created

data.​createdBystring(uuid)required

The ID of the user who created this Webhook Subscription

data.​updatedAtstring(date-time)required

Date when this Webhook Subscription was last updated

data.​updatedBystring(uuid)required

The ID of the user who last updated this Webhook Subscription

data.​filtersobject(Map_WebhookEventType_Filters)
Response
application/json
{
  "data": {
    "id": "cb452b81-6748-40ab-af85-6559b371bc5d",
    "name": "Dashboard Integration",
    "subscribedEvents": [ … ],
    "url": "https://example.webhook/dashboard_integration",
    "headers": { … },
    "secretKey": "4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc",
    "enabled": true,
    "createdAt": "2023-08-01T09:30:15Z",
    "createdBy": "e979cc3b-17b2-4850-b049-13c758763d1c",
    "updatedAt": "2023-08-02T15:09:30Z",
    "updatedBy": "64b777c3-eb82-49fb-bb3e-294afb5d840c",
    "filters": { … }
  }
}

Webhook Subscription Last Delivery Statuses

Request

Get the latest delivery statuses of a Webhook Subscription.

Security
ApiKeyAuth
Path
webhookSubscriptionIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks/{webhookSubscriptionId}/delivery-status' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The Latest Delivery Statuses of a Webhook Subscription

Bodyapplication/json
dataArray of objects(EventDeliveryStatus)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Webhook Subscription Event Logs

Request

Get the latest Webhook Subscription Event logs.

Security
ApiKeyAuth
Path
webhookSubscriptionIdstring(uuid)required
eventstringrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The Webhook Subscription Event Logs

Bodyapplication/json
dataArray of objects(EventDeliveryLog)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations