Webhooks
Receba um HTTP POST assinado sempre que algo acontece num projeto, sem polling. Os webhooks alimentam os conectores do LLM Pulse para Zapier, Make e n8n e funcionam com qualquer backend personalizado. Disponível no plano Scale ou superior.
- Tipos de evento:
mention.created,competitor_mention.created,citation.created,prompt_execution.completed,sentiment.negative_detected(sentimento da marca negativo ou muito negativo),recommendation.completed,intelligence_task.completed,intelligence_task.updated(uma tarefa GEO Writer concluída foi editada manualmente ou revertida para a versão da IA),geo_audit_run.completed(uma execução de auditoria GEO terminou, independentemente do resultado),geo_audit_alert.triggered(uma execução agendada de auditoria GEO gerou um alerta, por exemplo, porque uma verificação crítica passou a falhar, a pontuação caiu ou o site deixou de responder),tracking_run.completed(uma execução de monitorização do projeto foi concluída e os respetivos dados estão prontos a ler). - Segurança: cada entrega inclui
X-LLMPulse-Event,X-LLMPulse-Delivery(id único) eX-LLMPulse-Signature(sha256=<hex>, HMAC-SHA256 do corpo em bruto calculado com o segredo da subscrição). Verifique a assinatura para autenticar as entregas. - Entrega: uma resposta 2xx confirma a receção do evento; caso contrário, são feitas até 5 tentativas no total, incluindo a primeira, com intervalos exponenciais entre tentativas. As subscrições são desativadas automaticamente após 20 entregas falhadas consecutivas.
POST/webhooks
Cria uma subscrição. Idempotente: reenviar o mesmo projeto + evento + URL devolve a subscrição existente, exceto se a chave de API ou a ligação OAuth que a criou tiver sido revogada. Nesse caso, a subscrição é substituída por uma nova, com um novo segredo. O segredo de assinatura (whsec_...) só é devolvido por este endpoint; guarde-o para verificar as assinaturas de entrega. Requer uma chave com âmbito read_write.
project_idobrigatórioevent_typeobrigatório, ver a lista de eventos acimatarget_urlobrigatório, URL HTTPS público; são rejeitados IPs privados, localhost e nomes de anfitrião internos
Máximo de 100 subscrições ativas por conta.
GET/webhooks
Lista as subscrições ativas da conta. Os itens correspondem à resposta de criação sem o segredo. Com uma chave de API só de leitura, cada target_url é devolvido mascarado: mantém apenas o esquema, o anfitrião e a porta (se não for a predefinida), seguidos de /…, porque o URL completo permitiria a qualquer pessoa enviar pedidos para o recetor. Uma chave com âmbito read_write recebe o URL completo.
project_idfiltro opcionalpageper_pagemáximo 100
DELETE/webhooks/:id
Elimina uma subscrição. O URL de destino deixa de receber eventos imediatamente. Requer uma chave com âmbito read_write.
:idid da subscrição
Devolve ERR_NOT_FOUND para subscrições que não pertencem à conta.
GET/webhooks/sample/:event_type
Até 3 exemplos de payloads de eventos para o tipo de evento, criados a partir dos dados reais mais recentes do projeto (ou um exemplo estático quando o projeto ainda não tem dados). Utilizado por editores de integração, como o carregador de exemplos do Zapier. Também disponível como a ferramenta MCP get_webhook_sample.
:event_typecaminhoproject_idobrigatório