Webhook

Introdução

Os Webhooks do Trinks.com permitem que eventos sejam notificados para outros sistemas por meio de requisições HTTPs contendo dados no formato JSON.

Serviços Utilizados

O Amazon SNS é usado para gerenciar e enviar notificações dos eventos. O endpoint de destino deve ser compatível com o protocolo do SNS para confirmação de assinatura e recebimento de mensagens. Documentação SNS - AWS

Configuração do Endpoint

• Requisitos do endpoint: HTTPS compatível com SNS.
• Passo de assinatura:
  1. Quando o endpoint é cadastrado, o SNS envia uma mensagem de confirmação contendo a propriedade SubscribeURL.
  2. O endpoint deve fazer uma requisição para essa URL para ativar o webhook. Detalhes aqui.

Fluxo de Informação

1. Um evento ocorre no sistema Trinks.
2. Uma notificação é enviada para o endpoint configurado com as informações detalhadas do evento no formato JSON.
3. Todas as notificações relacionadas a uma franquia são enviadas para o mesmo endpoint, independentemente do estabelecimento.
4. Todas as notificações dos eventos suportados são enviadas para a mesma URL cadastrada.

Eventos Suportados

Abaixo estão listados os principais eventos e suas descrições:

ID	Evento	Descrição
1	Fechamento de Conta	Dados sobre o fechamento de conta.
2	Estorno de Conta	Dados sobre estorno de fechamento.
3	Inclusão de Cliente	Novo cliente cadastrado.
4	Alteração de Cliente	Atualização de dados do cliente.
5	Inclusão de Profissional	Cadastro de profissional.
6	Alteração de Profissional	Atualização de dados do profissional.
7	Inativação de Profissional	Profissional inativado.
8	Cadastro de Estabelecimento	Novo estabelecimento cadastrado.
9	Exclusão de Estabelecimento	Estabelecimento removido.
10	Alteração de Estabelecimento	Dados do estabelecimento alterados.
11	Inclusão de Agendamento	Novo agendamento criado.
12	Alteração de Agendamento	Agendamento atualizado.
13	Exclusão de Agendamento	Agendamento excluído.

Estrutura de Mensagens JSON

Cada evento gera um JSON com a seguinte estrutura base:

JSON

{
  "Message": "{...}",
  "MessageId": "string",
  "Timestamp": "string",
  "Type": "string",
  "Signature": "string",
  "SigningCertURL": "string",
  "Subject": "string"
}

Ações Identificáveis

As ações nos eventos são definidas pelo campo Action:

• 1: Inclusão
• 2: Alteração
• 3: Exclusão
• 9: Estorno

Segurança

As mensagens são assinadas digitalmente para garantir a autenticidade. O sistema receptor deve verificar a assinatura usando a URL fornecida em SigningCertURL.

Observações

• Certifique-se de que seu endpoint esteja disponível 24/7 para evitar perda de notificações.
• Verifique sempre o tipo de ação e evento para processar corretamente as mensagens.

---

Se precisar de algum ajuste ou informações adicionais, é só avisar!