Catálogo de eventos

Esta página lista os tipos de evento (event_type) disponíveis para assinatura via webhook. A lista tende a crescer conforme novos produtos da FonteData ganham suporte a eventos em tempo real — o envelope da requisição é o mesmo para todos os tipos.

Eventos disponíveis (v1)

event_type	Quando dispara	Cobrança
sms.mo.received	O destinatário responde a uma mensagem enviada pela sua conta e o conteúdo não é uma palavra-chave de saída.	1 crédito por mensagem recebida
sms.optout	O destinatário responde com uma palavra-chave de saída (SAIR, STOP, CANCELAR, DESCADASTRAR, entre outras) e passa a ser recusado em todos os seus envios.	Gratuito

Os dois eventos dizem respeito a mensagens recebidas — ou seja, disparam a partir de uma resposta do destinatário, não de um envio feito pela sua aplicação. A cobrança acontece na chegada da mensagem, independentemente de o webhook ter sido entregue ou não.

O envelope do evento

Toda entrega de webhook — independentemente do event_type — tem o mesmo formato de envelope:

{
  "event_id": "evt_5c1d0e00-0000-0000-0000-000000000000",
  "event_type": "sms.mo.received",
  "occurred_at": "2026-08-03T18:00:00Z",
  "data": {
    "request_id_origem": "7f3a1c92-0000-0000-0000-000000000000",
    "de": "5511999999999",
    "mensagem": "Pode confirmar para amanhã",
    "recebido_em": "2026-08-03T18:00:00Z"
  }
}

Campos do envelope

Campo	Descrição
event_id	Identificador único do evento (prefixo evt_). Use este valor para deduplicar entregas — veja Reentrega e confiabilidade.
event_type	O tipo do evento, um dos valores da tabela acima.
occurred_at	Data e hora (UTC, ISO 8601) de quando o evento ocorreu na FonteData.
data	Objeto com os campos específicos do evento. Para os eventos sms.*, veja abaixo.

Campos de data (eventos sms.*)

Campo	Descrição
request_id_origem	O request_id do envio que originou esta resposta. Vem null quando não foi possível correlacionar a resposta a um envio específico.
de	Número de quem respondeu, com DDI e DDD (ex.: 5511999999999).
mensagem	Conteúdo textual da mensagem recebida, como chegou do destinatário.
recebido_em	Data e hora (UTC, ISO 8601) de quando a mensagem foi recebida pela FonteData.

Selecionando eventos no cadastro

Ao cadastrar um webhook no painel (veja Visão geral), você escolhe quais event_type deseja receber. É possível assinar todos os eventos sms.* ou apenas um subconjunto — por exemplo, só sms.mo.received, se você já trata a saída por outro caminho.

O event_id é o identificador estável da mensagem recebida: é por ele que se deduplica quando uma entrega é repetida (veja Reentrega e confiabilidade).