Skip to main content
POST
Send a test event to a webhook

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

Body

application/json
eventType
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
mockData
object

Optional overrides applied to the sample payload.

Response

Result of the test request to your endpoint

success
boolean
required

true when the request reached your endpoint (regardless of the HTTP status it returned).

statusCode
integer
required

HTTP status returned by your endpoint; 0 when the request could not be completed.

response
string
required

Response body returned by your endpoint.

responseTime
integer
required

Round-trip time in milliseconds.

error
string

Error message when the request could not be completed (timeout, DNS failure, ...).