List webhooks

Error

A valid request URL is required to generate request examples

[
  {
    "WebhookID": "00000000000000000000000000000005",
    "WebhookName": "Example webhook",
    "URL": "https://example.com/webhook",
    "Events": [
      "User comment"
    ]
  }
]

Error

A valid request URL is required to generate request examples

[
  {
    "WebhookID": "00000000000000000000000000000005",
    "WebhookName": "Example webhook",
    "URL": "https://example.com/webhook",
    "Events": [
      "User comment"
    ]
  }
]

Authorizations

ClientID

string

header

required

ApiKey

string

header

required

Query Parameters

AccountID

string

Account identifier for the lookup.

WebhookID

string

Return only the subscription with this ID.

Response

An array of webhook subscriptions.

WebhookID

string

Unique identifier of the webhook.

WebhookName

string

Name of the webhook.

URL

string

Destination URL.

Events

string[]

Headers

any

Configured headers. May contain sensitive values.

CreatedOn

string

Time the webhook was created.

CreatedBy

string | null

Name of the user who created the webhook.

Getting started

Assets

Locations

Carriers

Labels

Accounts

Users

Events

Webhooks

Advanced

Authorizations

Query Parameters

Response