Skip to main content
POST
/
projects
/
{project_reference}
/
webhooks
/
{webhook_definition_id}
/
run
Run Project Webhook
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/webhooks/{webhook_definition_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": null
}
'
{
  "webhook_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "<string>",
  "canonical_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "latest_event_id": 1,
  "status": "<string>",
  "duplicate": true,
  "error_code": "<string>",
  "error_message": "<string>",
  "invoked_by": "<string>",
  "received_at": "<string>",
  "completed_at": "<string>",
  "payload": null
}

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
unknown

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
string
required
​
duplicate
boolean
required
​
error_code
string | null
required
​
error_message
string | null
required
​
invoked_by
string | null
required
​
received_at
string | null
required
​
completed_at
string | null
required
​
payload
unknown