Skip to main content
GET
List webhook subscriptions

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Workstation application ID

Query Parameters

isActive
boolean

Filter by active state.

eventType
enum<string>

Only return webhooks subscribed to this event. Events a webhook can subscribe to:

  • task.completed — a task run finished successfully and is ready for review.
  • task.approved — a task was reviewed and approved.
  • task.approval-revoke — an approved task was sent back to validating.
  • task.failed — a task run ended with a failure (errorMessage is set in the payload).
Available options:
task.completed,
task.approved,
task.approval-revoke,
task.failed
limit
integer
default:10

Page size. Defaults to 10, clamped to 1–100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip. Defaults to 0.

Required range: x >= 0

When true, meta.links are returned as objects instead of query strings.

page
string

Accepted for compatibility but ignored; use offset.

Response

Paginated webhook subscriptions

data
object[]
required
meta
object
required