Browse the API30

webhooks

get

/api/v1/webhooks

The endpoints this key's organization has registered.

Scope: webhooks:manage
Rate limit: 200 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope webhooks:manage; a key without it receives 403 forbidden.

Query parameters

pageintegerdefault 1min 1

per_pageintegerdefault 25min 1max 100

Request body

This operation takes no request body.

Response

200application/json

dataSerializedWebhookSubscription[]required

paginationobjectrequired

pagenumberrequired

per_pagenumberrequired

totalnumberrequired

total_pagesnumberrequired

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/webhooks?page=1&per_page=25" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "data": [
    {
      "id": string,
      "url": string,
      "events": [
        string
      ],
      "products": [
        string
      ],
      "mode": string,
      "status": string,
      "description": string | null,
      "created_at": string | null,
      "updated_at": string | null
    }
  ],
  "pagination": {
    "page": number,
    "per_page": number,
    "total": number,
    "total_pages": number
  }
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.