List webhook subscriptions

Your Company APIWebhook subscriptions

GEThttps://api.your-company.example/v1/webhook-subscriptions

AuthenticationRequires bearerAuth.

Description

Returns webhook destinations configured for the Workspace.

Request

curl "https://api.your-company.example/v1/webhook-subscriptions?limit=20&cursor=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.your-company.example/v1/webhook-subscriptions?limit=20&cursor=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
  },
});

import requests

response = requests.get(
    "https://api.your-company.example/v1/webhook-subscriptions",
    params={
      "limit": "20",
      "cursor": "string"
    },
    headers={
      "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response200JSON

{
  "data": [
    {
      "id": "whs_01JAZ92C4Q",
      "url": "https://contracts.example-counterparty.example/hooks/your-company",
      "events": [
        "matter.turn_completed",
        "matter.executed",
        "approval.requested"
      ],
      "status": "active",
      "created_at": "2026-07-01T17:10:00Z"
    }
  ],
  "next_cursor": null
}

Parameters

limitqueryintegerdefault: 20

Maximum number of records to return, from 1 to 100.

cursorquerystring

Opaque cursor from the previous page response.

Responses

200A page of webhook subscriptions.application/json

dataobject[]required

Array item fields

idstringrequired

urlstring <uri>required

eventsstring[]required

statusstringrequired

Allowed values: activepaused

created_atstring <date-time>required

next_cursorstring | nullrequired

Example response

{
  "data": [
    {
      "id": "whs_01JAZ92C4Q",
      "url": "https://contracts.example-counterparty.example/hooks/your-company",
      "events": [
        "matter.turn_completed",
        "matter.executed",
        "approval.requested"
      ],
      "status": "active",
      "created_at": "2026-07-01T17:10:00Z"
    }
  ],
  "next_cursor": null
}

401The API key is missing, malformed, expired, or revoked.application/json

errorobjectrequired

Object fields

codestringrequired

Stable machine-readable error code.

messagestringrequired

Human-readable summary.

request_idstringrequired

Identifier to include in a support ticket.

detailsobject[]

Array item fields

fieldstringrequired

Request field with an issue.

issuestringrequired

Human-readable validation problem.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Provide a valid bearer API key.",
    "request_id": "req_01JAZA0P8M"
  }
}