Skip to main content
POST
/
api
/
v2
/
webhooks
Add Webhook
curl --request POST \
  --url 'https://api.vida.dev/api/v2/webhooks?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
  "label": "Zapier Hook",
  "type": "conversation"
}
'
{
  "success": true,
  "message": "Webhook created successfully",
  "webhooks": [
    {
      "userId": 3,
      "label": "Zapier Hook",
      "timestamp": 1678829072,
      "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
      "type": "conversation"
    }
  ]
}

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
​
url
string
required

Webhook URL

Example:

"https://hooks.zapier.com/hooks/catch/123456/abcdef"

​
label
string
required

Friendly label for webhook

Example:

"Zapier Hook"

​
type
enum<string>
required

Webhook type

Available options:
conversation,
incoming,
contact
Example:

"conversation"

Response

OK