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"
}
'
import requests

url = "https://api.vida.dev/api/v2/webhooks?token="

payload = {
    "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef",
    "label": "Zapier Hook",
    "type": "conversation"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://hooks.zapier.com/hooks/catch/123456/abcdef',
    label: 'Zapier Hook',
    type: 'conversation'
  })
};

fetch('https://api.vida.dev/api/v2/webhooks?token=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vida.dev/api/v2/webhooks?token=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.zapier.com/hooks/catch/123456/abcdef',
    'label' => 'Zapier Hook',
    'type' => 'conversation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vida.dev/api/v2/webhooks?token="

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.zapier.com/hooks/catch/123456/abcdef\",\n  \"label\": \"Zapier Hook\",\n  \"type\": \"conversation\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vida.dev/api/v2/webhooks?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.zapier.com/hooks/catch/123456/abcdef\",\n  \"label\": \"Zapier Hook\",\n  \"type\": \"conversation\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vida.dev/api/v2/webhooks?token=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.zapier.com/hooks/catch/123456/abcdef\",\n  \"label\": \"Zapier Hook\",\n  \"type\": \"conversation\"\n}"

response = http.request(request)
puts response.read_body
{
  "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,
agent,
onboarding
Example:

"conversation"

Response

OK