Webhooks
Envie eventos de leitura para qualquer URL com webhooks personalizados. Perfeito para construir suas próprias automações e integrações.
Tela de configuração de webhook
Webhooks permitem que você receba notificações em tempo real sobre sua atividade de leitura. Quando um evento ocorre, o Book Reading Habit envia uma requisição HTTP POST para a URL especificada com os dados do evento em formato JSON.
O que são webhooks?
Webhooks permitem que você receba notificações em tempo real sobre sua atividade de leitura. Quando um evento ocorre, o Book Reading Habit envia uma requisição HTTP POST para a URL especificada com os dados do evento em formato JSON.
Como os webhooks funcionam
Quando você configura uma URL de webhook, o Book Reading Habit enviará notificações automaticamente sempre que certos eventos ocorrerem:
- Um evento ocorre no Book Reading Habit (ex: você completa uma sessão de leitura)
- O app envia uma requisição HTTP POST para sua URL de webhook
- Seu servidor recebe o payload JSON e pode processá-lo como quiser
Configuração
Configure seu webhook com as seguintes opções:
Nome do webhook
Um nome amigável para identificar este webhook
URL do webhook
A URL para onde as requisições POST serão enviadas
Chave secreta (opcional)
Se informada, as requisições incluem um header X-Signature-256 com uma assinatura HMAC para verificação
Eventos
Selecione quais eventos devem disparar este webhook
Formato do payload
Todos os payloads de webhook são enviados como JSON com a seguinte estrutura:
{
"eventType": "session.completed",
"timestamp": "2024-12-04T10:30:00Z",
"book": { ... },
"session": { ... },
"metadata": null
}
Saiba mais
Tipos de evento
Lista completa dos 16 eventos que você pode assinar
Estrutura do payload
Estrutura detalhada dos payloads de webhook com todos os campos
Boas práticas de segurança
Sempre use URLs HTTPS e defina uma chave secreta para verificar as requisições do webhook. A chave secreta é usada para gerar uma assinatura HMAC que você pode validar no seu servidor.