Skip to main content
GET
Get webhook subscription

Authorizations

Authorization
string
header
required

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

Path Parameters

webhookId
string<uuid>
required

Webhook subscription ID

Response

Webhook subscription

A webhook subscription of a Workstation application.

id
string<uuid>
required
promptApplicationId
string<uuid> | null
required

Application the webhook belongs to.

name
string
required
Maximum string length: 256
url
string
required

Endpoint that receives the events.

Maximum string length: 2048
events
enum<string>[]
required

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
headers
object | null
required

Headers sent verbatim with every delivery. Use them for authentication (for example authorization or x-api-key).

sensitiveHeaders
string[]
required

Names of headers considered sensitive. Stored as provided; the API does not currently mask them in responses.

method
string | null
required

HTTP method used for deliveries. Defaults to POST.

Maximum string length: 10
isActive
boolean
required

Inactive webhooks receive no deliveries.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time> | null
required