TAtalon
Webhooks

List webhooks

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List all webhooks.

get/v1/webhooks

Request

Query parameters

applicationIdsstring

Checks if the given catalog or its attributes are referenced in the specified Application ID.

Note: If no Application ID is provided, we check for all connected Applications.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

creationType'templateWebhooks' | 'webhooks'

Filter results by creation type.

visibility'visible' | 'hidden'

Filter results by visibility.

outgoingIntegrationsTypeIdinteger

Filter results by outgoing integration type ID.

titlestring

Filter results performing case-insensitive matching against the webhook title.

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "modified": "2021-09-12T10:12:42Z",
      "title": "Send message",
      "description": "A webhook to send a coupon to the user.",
      "verb": "POST",
      "url": "www.my-company.com/my-endpoint-name",
      "headers": [
        "{\"Authorization\": \"Basic bmF2ZWVua3VtYXIU=\"}",
        "{\"Content-Type\": \"application/json\"}"
      ],
      "payload": "{\n\t\"message\": \"${message}\"\n}",
      "params": [],
      "enabled": true,
      "authenticationId": 1,
      "outgoingIntegrationTemplateId": 1,
      "outgoingIntegrationTypeId": 1,
      "outgoingIntegrationTypeName": "Braze"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.