Skip to main content
POST
/
projects
/
{project_reference}
/
webhooks
Create Project Webhook
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "target": {
    "id": "<string>",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "prompt_template": "<string>",
  "event_filter": {
    "conditions": [
      {
        "path": "<string>",
        "value": null
      }
    ]
  }
}
'
{
  "webhook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "target": {
      "id": "<string>",
      "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "prompt_template": "<string>",
    "event_filter": {
      "conditions": [
        {
          "path": "<string>",
          "value": null
        }
      ]
    },
    "webhook_id": "<string>",
    "webhook_url": "<string>",
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled_at": "<string>",
    "disabled_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "webhook_secret": "<string>"
}

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

Body

application/json
name
string
required
Required string length: 1 - 120
target
object
required
prompt_template
string
Required string length: 1 - 20000
event_filter
object

Response

Created webhook

webhook
object
required
webhook_secret
string
required