Webhooks

Create a webhook endpoint

Register a destination. An endpoint created here is identical to one created in Connectors → Webhooks, including flipping the connector card to connected.

Credential: API token · Role: owner or admin (manage_team)

Warning

events is required. Omitting it is a 400 naming the field — not a subscription to everything. Pass ["*"] if you genuinely want every event, including ones added later. handoff.* payloads carry real customer message text, so subscribing a new URL to them because a field was left blank is not a convenience.

channels is optional and defaults to every channel, precisely because a channel filter can only ever narrow an event selection. The four billing.* events have no channel, so a channel filter never hides them.

Warning

The signing secret is returned by this response only (and by rotate-secret). It is never on a list, a GET or a PATCH, and there is no way to recover it later — store it now.

POST

webhooks

Create a webhook endpoint

curl --request POST \
  --url https://api.peeve.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/hooks/peeve",
  "label": "Prod",
  "events": [
    "handoff.created",
    "handoff.message.created"
  ]
}
'

import requests

url = "https://api.peeve.ai/v1/webhooks"

payload = {
    "url": "https://example.com/hooks/peeve",
    "label": "Prod",
    "events": ["handoff.created", "handoff.message.created"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/hooks/peeve',
    label: 'Prod',
    events: ['handoff.created', 'handoff.message.created']
  })
};

fetch('https://api.peeve.ai/v1/webhooks', 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.peeve.ai/v1/webhooks",
  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://example.com/hooks/peeve',
    'label' => 'Prod',
    'events' => [
        'handoff.created',
        'handoff.message.created'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.peeve.ai/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.peeve.ai/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peeve.ai/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "webhook_endpoint",
    "url": "<string>",
    "label": "<string>",
    "events": [
      "session.started"
    ],
    "channels": [
      "human"
    ],
    "enabled": true,
    "secret_hint": "<string>",
    "secret_set_at": "2023-11-07T05:31:56Z",
    "last_delivery_at": "2023-11-07T05:31:56Z",
    "last_status": "<string>",
    "last_response_code": 123,
    "secret": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

An API token (pv_ut_…) as Authorization: Bearer pv_ut_…. X-Peeve-Key is accepted too. Never a query parameter — URLs end up in proxy logs and Referer headers.

The token carries its owner's live workspace role, re-read on every call.

Body

application/json

url

string

required

HTTPS only. Private, loopback, link-local and .internal destinations are refused.

Maximum string length: 2048

events

enum<string>[]

required

Required. [] is refused; ["*"] means everything.

Minimum array length: 1

Available options:

session.started,

session.resolved,

handoff.created,

handoff.message.created,

handoff.status.changed,

lead.created,

lead.status.changed,

meeting.booked,

meeting.status.changed,

billing.payment_failed,

billing.subscription.changed,

billing.credits_low,

billing.credits_expiring,

*

label

string | null

Maximum string length: 80

channels

enum<string>[] | null

Optional. Omit or null for every channel.

Available options:

human,

agent,

whatsapp,

messenger,

instagram,

email

enabled

boolean

default:true

false creates it paused.

Response

Created. The only response that carries the secret, besides rotate-secret.

object

string

required

The resource type, e.g. lead.

data

object

required

Show child attributes

request_id

string

required

Echoed in the X-Request-Id header. Quote it to support.

Create a webhook endpoint

curl --request POST \
  --url https://api.peeve.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/hooks/peeve",
  "label": "Prod",
  "events": [
    "handoff.created",
    "handoff.message.created"
  ]
}
'

import requests

url = "https://api.peeve.ai/v1/webhooks"

payload = {
    "url": "https://example.com/hooks/peeve",
    "label": "Prod",
    "events": ["handoff.created", "handoff.message.created"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/hooks/peeve',
    label: 'Prod',
    events: ['handoff.created', 'handoff.message.created']
  })
};

fetch('https://api.peeve.ai/v1/webhooks', 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.peeve.ai/v1/webhooks",
  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://example.com/hooks/peeve',
    'label' => 'Prod',
    'events' => [
        'handoff.created',
        'handoff.message.created'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.peeve.ai/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.peeve.ai/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peeve.ai/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/hooks/peeve\",\n  \"label\": \"Prod\",\n  \"events\": [\n    \"handoff.created\",\n    \"handoff.message.created\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "webhook_endpoint",
    "url": "<string>",
    "label": "<string>",
    "events": [
      "session.started"
    ],
    "channels": [
      "human"
    ],
    "enabled": true,
    "secret_hint": "<string>",
    "secret_set_at": "2023-11-07T05:31:56Z",
    "last_delivery_at": "2023-11-07T05:31:56Z",
    "last_status": "<string>",
    "last_response_code": 123,
    "secret": "<string>"
  },
  "request_id": "<string>"
}

Overview

Sessions

Contacts

Users

Leads

Meetings

Hand-offs

Analytics

Configuration

Webhooks

Ask

Create a webhook endpoint

Authorizations

Body

Response