Skip to main content
GET
/
projects
/
{project_reference}
/
webhooks
/
{webhook_definition_id}
Get Project Webhook
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/webhooks/{webhook_definition_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

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

Response

Webhook

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
name
string
required
​
source
enum<string>
required
Available options:
webhook
​
target
object
required
​
prompt_template
string | null
required
​
event_filter
object
required
​
status
enum<string>
required
Available options:
draft,
enabled,
disabled
​
webhook_id
string
required
​
webhook_url
string
required
​
created_by_user_id
string<uuid>
required
​
enabled_at
string | null
required
​
disabled_at
string | null
required
​
created_at
string
required
​
updated_at
string
required