Convensão

Todas as notificações enviadas pelo nosso sistema seguem uma estrutura padrão, composta por quatro propriedades principais: created_at, data, id, e type. Essa convenção garante que você sempre saiba o que esperar e como processar as informações recebidas.

Nossa API utiliza o formato snake_case para todas as propriedades dos objetos JSON. Este é um estilo de nomenclatura em que cada palavra é separada por um sublinhado (_) e todas as letras são minúsculas. Exemplos incluem created_at.

Explicação das Propriedades

created_at: A data e hora em que o evento ocorreu, seguindo o padrão ISO 8601. Essa marcação de tempo é essencial para rastrear quando os eventos acontecem.
data: Um objeto contendo os detalhes específicos do evento. Essa é a parte da notificação que varia de acordo com o tipo de evento, fornecendo informações relevantes para você processar.
id: O identificador único da notificação. Esse ID pode ser usado para rastrear, confirmar o recebimento ou evitar o processamento duplicado de notificações.
type: O tipo de evento que disparou a notificação. Esse campo ajuda a determinar a natureza do evento e como a informação contida em data deve ser interpretada. Consulte a lista de eventos para mais detalhes.

Exemplo de Notificação

{
  "created_at": "2024-03-14T23:33:13.623Z",
  "data": {
    // Detalhes específicos do evento
  },
  "id": "so9lv3u3pu81he8gumfa4",
  "type": "message.received"
}