Webhooks e eventos

GET`/v1/webhook-endpoints`

Listar endpoints de webhook

Permissão: webhooks:write

Resposta `200`

Nome	Tipo	Descrição
`data` obrigatório	`object[]`
`data[].id` obrigatório	`string`
`data[].url` obrigatório	`string`
`data[].events` obrigatório	`string[]`
`data[].status` obrigatório	`"active" \| "disabled"`
`data[].livemode` obrigatório	`boolean`
`data[].created_at` obrigatório	`string`

Exemplo

curl

curl "https://api.kanutus.com/v1/webhook-endpoints" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/webhook-endpoints", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "GET",
    "https://api.kanutus.com/v1/webhook-endpoints",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API

GET /v1/webhook-endpoints

Respostas por status

200 Endpoints of this environment

200

{
  "data": [
    {
      "id": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "status": "active",
      "livemode": true,
      "created_at": "string"
    }
  ]
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

POST`/v1/webhook-endpoints`

Criar endpoint de webhook (o segredo de assinatura aparece uma vez)

Permissão: webhooks:write

Corpo da requisição

Nome	Tipo	Descrição
`url` obrigatório	`string`	length 0–2000
`events` obrigatório	"room.started" \| "room.ended" \| "room.participant_joined" \| "room.participant_left" \| "session.started" \| "session.ended" \| "call.ringing" \| "call.answered" \| "call.voicemail" \| "call.completed" \| "call.failed" \| "call.blocked" \| "call.ended" \| "meeting.created" \| "meeting.updated" \| "meeting.canceled" \| "booking.created" \| "booking.rescheduled" \| "booking.canceled" \| "transcript.ready" \| "summary.ready" \| "voice.consent_completed" \| "voice.ready" \| "voice.failed" \| "usage.threshold" \| "credential.expiring"[]
`description`	`string`	length 0–200

Resposta `201`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`url` obrigatório	`string`
`events` obrigatório	`string[]`
`status` obrigatório	`"active" \| "disabled"`
`livemode` obrigatório	`boolean`
`created_at` obrigatório	`string`
`secret` obrigatório	`string`	whsec_… shown only now

Exemplo

curl

curl -X POST "https://api.kanutus.com/v1/webhook-endpoints" \
  -H "Authorization: Bearer $KANUTUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","events":["room.started"],"description":"string"}'

Node.js

const res = await fetch("https://api.kanutus.com/v1/webhook-endpoints", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"url":"https://example.com","events":["room.started"],"description":"string"}),
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "POST",
    "https://api.kanutus.com/v1/webhook-endpoints",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
    json={"url":"https://example.com","events":["room.started"],"description":"string"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API Corpo da requisição (JSON)

POST /v1/webhook-endpoints

Respostas por status

201 Created

201

{
  "id": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "status": "active",
  "livemode": true,
  "created_at": "string",
  "secret": "string"
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

DELETE`/v1/webhook-endpoints/{id}`

Apagar um endpoint de webhook

Permissão: webhooks:write

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Resposta `200`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`deleted` obrigatório	`true`

Exemplo

curl

curl -X DELETE "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "DELETE",
    "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório

DELETE /v1/webhook-endpoints/{id}

Respostas por status

200 Deleted

200

{
  "id": "string",
  "deleted": true
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

POST`/v1/webhook-endpoints/{id}/rotate-secret`

Trocar o segredo de assinatura (os dois assinam por 24 h)

Permissão: webhooks:write

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Resposta `200`

Nome	Tipo	Descrição
`id` obrigatório	`string`
`secret` obrigatório	`string`

Exemplo

curl

curl -X POST "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/rotate-secret" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/rotate-secret", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "POST",
    "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/rotate-secret",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório

POST /v1/webhook-endpoints/{id}/rotate-secret

Respostas por status

200 New secret, shown once

200

{
  "id": "string",
  "secret": "string"
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

POST`/v1/webhook-endpoints/{id}/test`

Enviar agora um evento de teste assinado

Permissão: webhooks:write

Parâmetros

Nome	Tipo	Descrição
`id` obrigatório	`path · string`

Corpo da requisição

Nome	Tipo	Descrição
`type`	"room.started" \| "room.ended" \| "room.participant_joined" \| "room.participant_left" \| "session.started" \| "session.ended" \| "call.ringing" \| "call.answered" \| "call.voicemail" \| "call.completed" \| "call.failed" \| "call.blocked" \| "call.ended" \| "meeting.created" \| "meeting.updated" \| "meeting.canceled" \| "booking.created" \| "booking.rescheduled" \| "booking.canceled" \| "transcript.ready" \| "summary.ready" \| "voice.consent_completed" \| "voice.ready" \| "voice.failed" \| "usage.threshold" \| "credential.expiring"	default "meeting.created"

Resposta `200`

Nome	Tipo	Descrição
`ok` obrigatório	`boolean`
`status` obrigatório	`number \| null`
`latency_ms` obrigatório	`number`
`delivery_id` obrigatório	`string`
`error` obrigatório	`string \| null`

Exemplo

curl

curl -X POST "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/test" \
  -H "Authorization: Bearer $KANUTUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"meeting.created"}'

Node.js

const res = await fetch("https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/test", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"type":"meeting.created"}),
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "POST",
    "https://api.kanutus.com/v1/webhook-endpoints/8f14e45f-ceea-4c8e-9b3a-2f1d5a7c3b10/test",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
    json={"type":"meeting.created"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API id path obrigatório Corpo da requisição (JSON)

POST /v1/webhook-endpoints/{id}/test

Respostas por status

200 Delivery result

200

{
  "ok": true,
  "status": 0,
  "latency_ms": 0,
  "delivery_id": "string",
  "error": "string"
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

404 Not found

404 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 404,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

GET`/v1/events`

Eventos recentes (para conciliar o que o webhook perdeu; 30 dias)

Permissão: events:read

Parâmetros

Nome	Tipo	Descrição
`type`	`query · string`
`since`	`query · string`
`limit`	`query · integer`

Resposta `200`

Nome	Tipo	Descrição
`data` obrigatório	`object[]`
`data[].id` obrigatório	`string`
`data[].type` obrigatório	`string`
`data[].created` obrigatório	`integer`
`data[].livemode` obrigatório	`boolean`
`data[].data` obrigatório	`object`
`data[].data.object` obrigatório	`object`

Exemplo

curl

curl "https://api.kanutus.com/v1/events" \
  -H "Authorization: Bearer $KANUTUS_API_KEY"

Node.js

const res = await fetch("https://api.kanutus.com/v1/events", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KANUTUS_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os, uuid, requests

r = requests.request(
    "GET",
    "https://api.kanutus.com/v1/events",
    headers={"Authorization": f"Bearer {os.environ['KANUTUS_API_KEY']}"},
)
print(r.status_code, r.json())

Testar agora

Roda no seu navegador contra a API de verdade. Use uma chave kt_test_: nada é cobrado. A chave fica só nesta aba.

Chave de API type query since query limit query

GET /v1/events

Respostas por status

200 Events, newest first

200

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "created": 0,
      "livemode": true,
      "data": {
        "object": {}
      }
    }
  ]
}

400 Invalid request

400 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 400,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

401 Missing, invalid, expired or revoked credential

401 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 401,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

403 Missing permission, blocked or not allowed

403 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 403,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

429 Rate limit exceeded (see RateLimit-* and Retry-After headers)

429 application/problem+json

{
  "type": "https://docs.kanutus.com/errors",
  "title": "<code>",
  "status": 429,
  "code": "<code>",
  "message": "…",
  "request_id": "req_…"
}

Ver todos os códigos de erro

Webhooks e eventos

GET/v1/webhook-endpoints#

Resposta 200

Exemplo

Respostas por status

POST/v1/webhook-endpoints#

Corpo da requisição

Resposta 201

Exemplo

Respostas por status

DELETE/v1/webhook-endpoints/{id}#

Parâmetros

Resposta 200

Exemplo

Respostas por status

POST/v1/webhook-endpoints/{id}/rotate-secret#

Parâmetros

Resposta 200

Exemplo

Respostas por status

POST/v1/webhook-endpoints/{id}/test#

Parâmetros

Corpo da requisição

Resposta 200

Exemplo

Respostas por status

GET/v1/events#

Parâmetros

Resposta 200

Exemplo

Respostas por status

GET`/v1/webhook-endpoints`

Resposta `200`

POST`/v1/webhook-endpoints`

Resposta `201`

DELETE`/v1/webhook-endpoints/{id}`

Resposta `200`

POST`/v1/webhook-endpoints/{id}/rotate-secret`

Resposta `200`

POST`/v1/webhook-endpoints/{id}/test`

Resposta `200`

GET`/v1/events`

Resposta `200`