Skip to main content
POST
Run project webhook

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
Minimum string length: 1
webhook_definition_id
string<uuid>
required

Body

application/json
payload
any

Response

Webhook run accepted

webhook_event_id
string<uuid>
required
webhook_definition_id
string<uuid>
required
project_id
string<uuid>
required
conversation_id
string<uuid> | null
required
message_id
string<uuid> | null
required
run_id
string | null
required
canonical_run_id
string<uuid> | null
required
latest_event_id
integer | null
required
Required range: x >= 0
status
enum<string>
required

Webhook run status: received, queued, running, completed, failed, cancelled or ignored. A linked agent run overlays running (also while it waits for a tool), completed, failed or cancelled.

Available options:
received,
queued,
running,
completed,
failed,
cancelled,
ignored
duplicate
boolean
required
error_code
string | null
required
error_message
string | null
required
invoked_by
string | null
required
manual_invoked_by_user_id
string<uuid> | null
required
received_at
string | null
required
completed_at
string | null
required
payload
any