List webhooks

GET

/api/admin/webhooks

const url = 'https://example.com/api/admin/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/admin/webhooks \
  --header 'Authorization: Bearer <token>'

Retrieves all webhook configurations

Authorizations

bearerAuth

Responses

200

Webhooks retrieved successfully

application/json

object

count

Total number of webhooks

number

items

required

Array of webhooks

Array<object>

object

required

Webhook ID

string

name

required

Webhook name

string

url

required

Webhook URL endpoint

string format: uri

events

Events that trigger the webhook

Array<string>

enabled

Whether webhook is active

boolean

secret

Webhook secret for signature verification

string

headers

Custom headers to include

object

key

additional properties

string

payloadSize

Outgoing payload mode

string

Allowed values: full basic none custom

customPayload

JSON template string used as the entire request body when payloadSize is ‘custom’. String values support {{path}} placeholders resolved against {event, data, webhook}; a value that is exactly one placeholder preserves the source value’s type.

string

createdAt

Creation timestamp

number

updatedAt

Last update timestamp

number

Example

{
  "items": [
    {
      "id": "webhook-123",
      "name": "content-update-webhook",
      "url": "https://example.com/webhook",
      "events": [
        "item.created",
        "item.updated",
        "item.deleted"
      ],
      "enabled": true,
      "payloadSize": "full",
      "customPayload": "{\"id\": \"{{data.id}}\", \"msg\": \"Updated {{data.name}}\"}"
    }
  ]
}

400

Error retrieving webhooks