Documentação Para Desenvolvedores

Webhooks

Ao ativar o Webhook, sempre que houver alterações nos recursos integrados será feito uma requisição POST, para o endereço configurado contendo o recurso envolvido.


Nesta página:

  • Habilitando o Webhook

  • ID da Requisição

  • Retornando HTTP 200

  • Retornando HTTP de erro

  • Token de autenticação

  • Espera antes do envio

  • Limite de requisições simultâneas


Habilitando o Webhook

Para habilitar o webhook, acesse a área Webhooks, e informe os dados necessários do recurso e URL da aplicação que deve receber o POST da Guru.

ID da Requisição

Cada vez que o webhook é disparado, geramos um ID de requisição e enviamos no HEADER X-Request-ID.

Retornando HTTP 200

Para que o Guru considere o webhook como processado com sucesso, o status HTTP da resposta deve ser 200. Caso seu sistema falhe em responder HTTP 200, a retentativa é feita a cada minuto x número de tentativas até o total de 10 tentativas. Se falhar mais de 10 vezes é enviada uma notificação para todos os usuários administradores.

Retornos HTTP de erro

A Guru não tenta reenviar os webhooks caso o código de retorno seja:

  • 0

  • 401

  • 403

  • 404

  • 406

  • 410

  • 422

  • 505

  • 506

  • 510

  • 511

Caso não seja nenhum desses erros tentaremos entregar até 20 vezes, sempre adicionando 1 minuto ao tempo anterior.

Como, por exemplo:

  1. 2ª tentativa -> 1 minuto depois da primeira

  2. 3ª tentativa -> 2 minutos depois da segunda

  3. 4ª tentativa -> 3 minutos depois da terceira

  4. 5ª tentativa -> 4 minutos depois da quarta

Token de autenticação

Para validar que a requisição do webhook pertence ao Guru, é enviado o campo api_token.

Espera antes do envio

  • transações - 5 segundos

  • e-tickets - 5 segundos

  • assinaturas - 10 segundos

Limite de requisições simultâneas

  • 50 por cliente

  • 1 por url de destino e id do objeto

  • entre 5 e 15 por webhook (configurável pelo admin).

Sempre que qualquer um desses limites for atingido, o webhook será recolocado na fila com espera de 10 segundos.


Mais Recursos