Documentação de Webhooks

A Eventiza fornece um sistema de webhook que permite que você receba atualizações em tempo real sobre mudanças no status dos pedidos em seus eventos. Esse recurso permite que você automatize seus processos e mantenha seus sistemas sincronizados com as informações mais recentes dos pedidos.

Configurando Webhooks

Para começar a receber notificações de webhook:

1. Faça login na sua conta Eventiza
2. Navegue até a seção de configurações da API: https://sistema.eventiza.com.br/meu-perfil/integracoes
3. Insira a URL onde você deseja receber as notificações de webhook e quais eventos deseja receber
4. Utilize o botão "ENVIAR EVENTO TESTE" para conferir se o servidor está recebendo os dados e retornando uma resposta de sucesso (Código 200)
5. Salve suas configurações

Payload de Webhooks

Mudança de status de pedido

Quando o status de um pedido muda, a Eventiza enviará uma solicitação POST para a URL especificada com um payload JSON. Aqui está um exemplo da estrutura do payload:

JSON

{
  "eventType": "ORDER_STATUS_CHANGE",
  "orderId": "ORD123456",
  "orderData": {},
  "eventId": "EVT123456",
  "eventData": {},
  "participantsData": {},
  "timestamp": 1731361411958,
  "newStatus": "finished",
  "previousStatus": "pending",
}

Importante: por questões de segurança, esta solicitação é enviada somente para usuários, com acesso à chave de API, cadastrados na equipe do evento com as seguintes funções:

• Proprietário
• Administrador

Códigos de Status

Os campos newStatus conterão um dos seguintes valores:

Código	Nome	Descrição
1	finished	Pedido pago e concluído
2	pending	Pedido aguardando pagamento
3	expired	Pagamento expirou
4	refunded	Um pedido pago foi reembolsado
5	canceled	Um pedido gratuito foi cancelado
6	rejected	Pedido não atende aos requisitos mínimos de segurança

Atualização dos dados de formulário de um ingresso

Quando os dados de formulário de um ingresso são atualizados, a Eventiza enviará uma solicitação POST para a URL especificada com um payload de JSON. Aqui está um exemplo da estrutura do payload:

JSON

{
  "eventType": "PARTICIPANT_FORM_UPDATE",
  "orderId": "ORD123456",
  "eventId": "EVT123456",
  "participantId": "PTC123456",
  "timestamp": 1731361411958,
  "newData": {},
  "previousData": {}
}

Importante: por questões de segurança, esta solicitação é enviada somente para usuários cadastrados na equipe do evento com as seguintes funções:

• Proprietário
• Administrador
• Gerente de participantes
• Apenas check-in

Tratando Webhooks

Para lidar corretamente com os webhooks recebidos:

1. Configure um endpoint em seu servidor para receber solicitações POST
2. Processe o payload e atualize seu sistema de acordo
3. Responda com um código de status 200 OK para confirmar o recebimento. Caso contrário, duas outras tentativas de reenvio serão efetuadas com um intervalo de 5 minutos entre elas.

Melhores Práticas

• Implemente tratamento de erros e registro adequados
• Configure uma lógica de repetição caso seu endpoint esteja temporariamente indisponível
• Processe webhooks de forma assíncrona para evitar timeouts
• Monitore o processamento de seus webhooks para garantir confiabilidade

Para quaisquer dúvidas ou problemas com webhooks, entre em contato com nossa equipe de suporte.