Get Webhooks

Get a list of webhooks

get

Gets details about all webhooks registered on the integration.

Authorizations

Bearer Token

AuthorizationstringRequired

Header parameters

x-api-keystringRequired

Responses

200

Returns a list of webhooks.

application/json

Contains webhook details as a response of listing webhooks.

400

Bad request

403

Forbidden due to insufficient privileges

get

/v1/webhooks

HTTPcURLJavaScriptPython

GET /v1/webhooks HTTP/1.1
Authorization: YOUR_API_KEY
x-api-key: text
Accept: */*

{
  "webhooks": [
    {
      "name": "text",
      "url": "text",
      "eventTypes": [
        "text"
      ],
      "enabled": true,
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get a specific webhook by event type

get

Gets details about a specific webhook based on event type

Authorizations

Bearer Token

AuthorizationstringRequired

Path parameters

eventTypestringRequired

Header parameters

x-api-keystringRequired

Responses

200

Returns the requested webhook.

application/json

Contains details about a webhook.

namestring · nullableOptional

The name of the webhook.

urlstring · nullableOptional

URL for the webhook to send events to.

eventTypesstring[] · nullableOptional

List of event types this webhook subscribes on.

enabledboolean · nullableOptional

Indicates the status of the webhook. If true events will be sent on the webhook, otherwise (false) event sendout is disabled.

idstring · uuidOptional

The webhook id.

400

Bad request

403

Forbidden due to insufficient privileges

get

/v1/webhooks/{eventType}

HTTPcURLJavaScriptPython

GET /v1/webhooks/{eventType} HTTP/1.1
Authorization: YOUR_API_KEY
x-api-key: text
Accept: */*

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Get a specific webhook by its id

get

Gets details about a specific webhook.

Authorizations

Bearer Token

AuthorizationstringRequired

Path parameters

webhookIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

Returns the requested webhook.

application/json

Contains details about a webhook.

namestring · nullableOptional

The name of the webhook.

urlstring · nullableOptional

URL for the webhook to send events to.

eventTypesstring[] · nullableOptional

List of event types this webhook subscribes on.

enabledboolean · nullableOptional

Indicates the status of the webhook. If true events will be sent on the webhook, otherwise (false) event sendout is disabled.

idstring · uuidOptional

The webhook id.

400

Bad request

403

Forbidden due to insufficient privileges

get

/v1/webhooks/{webhookId}

HTTPcURLJavaScriptPython

GET /v1/webhooks/{webhookId} HTTP/1.1
Authorization: YOUR_API_KEY
x-api-key: text
Accept: */*

{
  "name": "text",
  "url": "text",
  "eventTypes": [
    "text"
  ],
  "enabled": true,
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}