🌐Webhooks

🔔 Através do webhook, você pode receber notificações automáticas sempre que ocorrerem movimentações nos eventos ou reservas.

Assim, é possível ser avisado quando um setor tiver alterações na quantidade de lugares disponíveis ou quando uma cadeira for ocupada.

Dessa forma, você pode atualizar sistemas externos com as informações enviadas pela nossa plataforma.

⚡ Os webhooks resolvem diversos problemas comuns de integração com APIs, como:

• 🚫 Evitar a necessidade de fazer polling constante para obter informações atualizadas.

• 📩 Receber notificações em tempo real sobre eventos que não são resultado direto de uma chamada à API.

⚙️ Configurando Webhook

⚙️ Através do painel do sistema, você pode configurar quais eventos deseja receber via webhook.

📘 Consulte nosso tutorial abaixo para aprender como configurar o webhook corretamente.

Configurando Webhook

🔄 Funcionamento

🔔 Sempre que um dos eventos selecionados ocorrer, nossa plataforma fará uma requisição POST para a URL informada, enviando um payload no formato abaixo:

{
  "resource": "/eventos/19/apresentacoes/25/setores/40/",
  "topic": "event.sector.created",
  "attempts": "1",
  "sent": "2025-01-01 00:00:00",
  "received": "2025-01-01 00:00:00",
  "payload": {
    "CodigoEvento": "19",
    "CodigoApresentacao": "25",
    "CodigoSetor": "40",
    "Nome": "PLATEIA NUMERADA",
    "Tipo": "SetorNumerado",
    "QtdLugares": "10"
  }
}

⚠️ O payload enviado pode variar conforme o tipo de evento e contém diversas informações detalhadas.

Por isso, recomendamos que você aponte o webhook para um ambiente de testes e valide a requisição e o payload antes de iniciar o desenvolvimento das integrações.

✅ A URL que recebe a requisição do webhook deve retornar HTTP Code 200 — qualquer outro código será interpretado como falha.

📝 Todo o conteúdo da resposta é ignorado, mas armazenado para fins de log, portanto não envie informações sigilosas nas respostas das notificações de webhook.

📩 Entendo os dados recebidos

Nos dados retornados, existem informações muito importantes que devem ser monitoradas constantemente:

topic

Este é o Código do Evento, que deve ser utilizado para identificar o evento recebido em seu sistema.

resource

Nos casos em que o evento pode ser consultado, será retornado o caminho completo para consulta na API.

⚠️ Este campo nem sempre é retornado, pois há eventos enviados quando o registro é removido.

attempts

Indica a tentativa atual de envio desta mensagem.

sent

Indica o momento em que a mensagem foi criada e iniciadas as tentativas de envio.

received

Indica a data e hora da mensagem atual.

payload

Na propriedade "payload" são retornados todos os dados relacionados ao evento enviado.

⚠️ Falhas

Se o webhook receber um HTTP Code diferente de 200, a plataforma tentará reenviar o webhook mais 3 vezes.

As retentativas subsequentes ocorrem a cada 5 minutos.

🔹 Supondo que a primeira tentativa falhe às 08:00, as próximas tentativas seriam:

Tentativa	Hora
1	08:00
2	08:05
3	08:10

✅ Caso alguma das tentativas receba HTTP Code 200, nenhuma nova retentativa será realizada.

📢 Eventos Disponíveis

📘 Clique no link abaixo para conhecer todos os eventos disponíveis e visualizar exemplos de retorno de cada um deles:

Eventos

🛡️ Segurança

🔐 Clique no tutorial abaixo para conhecer as camadas de segurança que devem ser verificadas em sua aplicação, garantindo que nosso sistema consiga se conectar corretamente ao seu:

Segurança