Create a webhook endpoint

curl --request POST \
  --url https://api.meetdarwin.ai/v1/webhook_endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks/darwin",
  "events": [],
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhooks/darwin',
    events: [],
    description: '<string>'
  })
};

fetch('https://api.meetdarwin.ai/v1/webhook_endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.meetdarwin.ai/v1/webhook_endpoints"

payload = {
    "url": "https://example.com/webhooks/darwin",
    "events": [],
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "we_7h3k9m2p4q8r1s5t",
  "object": "webhook_endpoint",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "status": "enabled",
  "disabled_reason": "<string>",
  "failing_since": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

POST

webhook_endpoints

Create a webhook endpoint

curl --request POST \
  --url https://api.meetdarwin.ai/v1/webhook_endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks/darwin",
  "events": [],
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhooks/darwin',
    events: [],
    description: '<string>'
  })
};

fetch('https://api.meetdarwin.ai/v1/webhook_endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.meetdarwin.ai/v1/webhook_endpoints"

payload = {
    "url": "https://example.com/webhooks/darwin",
    "events": [],
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "we_7h3k9m2p4q8r1s5t",
  "object": "webhook_endpoint",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "status": "enabled",
  "disabled_reason": "<string>",
  "failing_since": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

{
  "type": "https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope",
  "title": "<string>",
  "status": 0,
  "code": "insufficient_scope",
  "detail": "<string>",
  "request_id": "req_8m2k4p0q1x7z9c3v5b6n",
  "param": "<string>"
}

Authorizations

Authorization

string

header

required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Headers

Idempotency-Key

string

Retry safely: the first response is replayed for 24 hours (not for streamed answers).

Maximum string length: 255

Body

application/json

url

string

required

Maximum string length: 2000

Example:

"https://example.com/webhooks/darwin"

events

enum<string>[]

required

Required array length: 1 - 40 elements

Available options:

*,

lead.captured,

handoff.requested,

meeting.booked,

meeting.rescheduled,

meeting.canceled,

conversation.started,

conversation.completed,

experiment.started,

experiment.winner_found,

knowledge.source_failed

description

string

Maximum string length: 300

Response

string

required

Pattern: ^we_

Example:

"we_7h3k9m2p4q8r1s5t"

object

string

required

Allowed value: "webhook_endpoint"

url

string

required

description

string

required

events

string[]

required

status

enum<string>

required

Available options:

enabled,

disabled

disabled_reason

string | null

required

failing_since

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

created_at

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

updated_at

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

secret

string

whsec_…, only when the endpoint is created or its secret rotated.

Get started

Build

Endpoints

Create a webhook endpoint

Authorizations

Headers

Body

Response