List hooks

Lists webhooks for a site

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/hooks?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/hooks?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/hooks?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/hooks?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/hooks?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/hooks?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/hooks?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Filtering

Use filter[event_eq] parameter to filter webhooks by event type:

Get webhooks for purchase events only

• GET /v1/hooks?filter[event_eq]=purchase

GET /v1/hooks

List hooks

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/hooks \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "hooks",
      "attributes": {
        "event": "purchase",
        "target_url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "resource_id": 123
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number] · integer

page[size] · integer

Number of documents

filter[event_eq] · enum<string>

Filter by event type, for example ?filter[event_eq]=purchase

Available options: purchase, form_submission, tag_added, tag_removed, payment_succeeded, order_created

Response

200

application/vnd.api+json

Success, list of hooks which the current user may access

data · object[]

Show child attributes