Registre assinaturas de webhooks de saída e envie payloads de amostra. Somente chave de API.

POST/v1/webhook-subscription/Chave de API

Create a webhook subscription (API-Key only)

Body: url, subscriptions. Event types include FOLLOWUPS_DAILY_FINISHED, FORMS_RESPONSE_CREATED.

Erros

Status	Quando
401	Missing/invalid/expired credential
403	Authenticated but not permitted
429	Throttled - Retry-After header set
400	Validation error

curl -sS -X POST 'https://api.dailybot.com/v1/webhook-subscription/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

POST/v1/webhook-subscription/sample/Chave de API

Deliver a sample event (API-Key only)

Body: event_type, url.

Erros

Status	Quando
401	Missing/invalid/expired credential
403	Authenticated but not permitted
429	Throttled - Retry-After header set
400	Validation error

curl -sS -X POST 'https://api.dailybot.com/v1/webhook-subscription/sample/' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

API de Webhooks

Crie e gerencie assinaturas de webhooks programaticamente. Solicite payloads de amostra para testar suas integrações.

Consulte o guia de Webhooks e Eventos para a lista completa de eventos suportados e estruturas de payload.

Resumo dos endpoints

Método	Endpoint	Descrição
POST	`/v1/webhooks/`	Criar uma assinatura de webhook
DELETE	`/v1/webhooks/{id}/`	Excluir uma assinatura de webhook
POST	`/v1/webhooks/{id}/sample/`	Solicitar um payload de amostra

POST /v1/webhooks/

Cria uma nova assinatura de webhook.

Parâmetros do corpo

Nome	Tipo	Obrigatório	Descrição
`url`	string (URL)	Sim	URL para receber os payloads do webhook. Deve usar HTTPS.
`events`	array de strings	Sim	Tipos de eventos para assinar (por exemplo, `["followups.response.completed"]`).
`name`	string	Não	Nome descritivo para o webhook.
`bearer_token`	string	Não	Bearer token enviado como header `X-BEARER` para verificação de assinatura.
`object_ids`	array de strings	Não	UUIDs específicos de check-in ou formulário para filtrar eventos (opcional).
`immediate_sample_event`	boolean	Não	Se true, enviar um evento de teste imediatamente após a criação.

curl -X POST "https://api.dailybot.com/v1/webhooks/" \
  -H "X-API-KEY: sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://seu-app.com/webhooks/dailybot",
    "events": ["followups.response.completed", "kudos.posted"],
    "name": "Webhook de Produção",
    "bearer_token": "seu-token-secreto",
    "immediate_sample_event": true
  }'

Resposta (201 Created):

{
  "id": "wh-1234-abcd",
  "url": "https://seu-app.com/webhooks/dailybot",
  "events": ["followups.response.completed", "kudos.posted"],
  "name": "Webhook de Produção",
  "created_at": "2026-04-06T10:00:00Z"
}

DELETE /v1/webhooks/{id}/

Exclui uma assinatura de webhook.

curl -X DELETE "https://api.dailybot.com/v1/webhooks/wh-1234-abcd/" \
  -H "X-API-KEY: sua_api_key"

Resposta (204 No Content)

POST /v1/webhooks/{id}/sample/

Solicita um payload de amostra para um tipo de evento específico. Útil para testar seu endpoint.

Parâmetros do corpo

Nome	Tipo	Obrigatório	Descrição
`event`	string	Sim	O tipo de evento para gerar uma amostra.

curl -X POST "https://api.dailybot.com/v1/webhooks/wh-1234-abcd/sample/" \
  -H "X-API-KEY: sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{"event": "followups.response.completed"}'

Resposta (200 OK):

{
  "status": "sent",
  "event": "followups.response.completed",
  "message": "Sample event payload sent to your webhook URL."
}

Eventos suportados

Evento	Categoria
`followups.response.completed`	Check-in
`followups.response.updated`	Check-in
`followups.response.deleted`	Check-in
`forms.response.created`	Formulários
`forms.response.updated`	Formulários
`forms.response.deleted`	Formulários
`kudos.posted`	Kudos
`organization.user_activated`	Organização
`organization.user_deactivated`	Organização
`organization.team_user_added`	Organização
`organization.team_user_removed`	Organização