- Categoria
- API
- Sentido
- Envio de eventos
- Formato
- JSON assinado em HMAC-SHA256
- Endereços
- Até 25 por organização
- Novas tentativas
- Até 6 tentativas, ao longo de mais de um dia
- Configuração
- Um endereço HTTPS e um segredo
- Planos
- Plano Enterprise
- Editor
- Upsellr
01O que os webhooks fazem
O sinal que faz avançar as suas ferramentas.
- 01
Um evento no fim de cada processamento
Concluído, com falha ou parado: no fim de cada processamento de enriquecimento ou de geração, a Upsellr envia o evento com o detalhe do processamento.
- 02
Assinado, para ser verificado
Cada envio inclui um identificador, um carimbo de data/hora e uma assinatura HMAC-SHA256 calculada com o seu segredo: a sua ferramenta verifica que vem mesmo da Upsellr.
- 03
Reenviado até ser recebido
Sem resposta 2xx em 10 segundos, a Upsellr volta a tentar após 1 minuto, 5 minutos, 30 minutos, 4 horas e, por fim, 24 horas.
- 04
Um registo de cada envio
Estado, código HTTP, número de tentativas e conteúdo: cada entrega pode ser consultada durante 7 dias, e um envio com falha reenvia-se com um clique.
- 05
Encadeie as suas ferramentas
Publique, avise uma equipa ou lance uma exportação assim que as fichas estiverem prontas: o webhook dá o sinal, a sua ferramenta faz o resto.
- 06
Mantenha o controlo
Desative um endereço, mude o seu segredo ou elimine-o: as novas tentativas pendentes são canceladas.
02Primeiros passos
Ligado em poucos minutos.
- 01
Abra as definições da organização
Secção API e webhooks, reservada a proprietários e administradores.
- 02
Adicione um endereço
Um URL em HTTPS, acessível a partir da internet.
- 03
Copie o segredo
Só é apresentado uma vez e serve para verificar a assinatura de cada envio.
- 04
Verifique a assinatura
Recalcule a assinatura HMAC-SHA256 do carimbo de data/hora e do conteúdo, e recuse um envio demasiado antigo.
- 05
Responda depressa
Uma resposta 2xx em menos de 10 segundos e, depois, trate do resto do seu lado.
03Eventos
Os eventos enviados.
| Evento | Enviado | Reenviado se necessário |
|---|---|---|
| Processamento concluído (workflow.run.completed) | Sim | Sim |
| Processamento com falha (workflow.run.failed) | Sim | Sim |
| Processamento parado (workflow.run.stopped) | Sim | Sim |
Compatibilidade e requisitos
- O plano Enterprise
- Um endereço HTTPS público, na porta 443
- Uma função de proprietário ou administrador
- Uma resposta 2xx em menos de 10 segundos
- Conselho: elimine duplicados pelo identificador do evento
O controlo é seu
Fiáveis por conceção.
- Assinados em HMAC-SHA256, com um segredo próprio para cada endereço
- Entregues pelo menos uma vez: elimine duplicados pelo identificador do evento
- Reenviados até 6 vezes, ao longo de mais de um dia
- Enviados por HTTPS, apenas para endereços públicos
04Perguntas
Perguntas sobre os webhooks da Upsellr.
Os webhooks estão incluídos no meu plano?
Estão reservados ao plano Enterprise, tal como a API.
Que eventos são enviados?
O fim de um processamento de enriquecimento ou de geração: concluído, com falha ou parado. Cada evento contém o detalhe do processamento.
Como verifico que um envio vem da Upsellr?
Recalcule a assinatura HMAC-SHA256 do carimbo de data/hora e do conteúdo com o seu segredo, compare-a com o cabeçalho X-Upsellr-Signature, e recuse um envio com mais de 5 minutos.
O que acontece se o meu servidor não responder?
Sem resposta 2xx em 10 segundos, a Upsellr volta a tentar após 1 minuto, 5 minutos, 30 minutos, 4 horas e, por fim, 24 horas. Um envio com falha também pode ser reenviado manualmente a partir do registo.
Posso receber o mesmo evento duas vezes?
Sim, é possível: a entrega é garantida pelo menos uma vez, sem ordem garantida. Elimine duplicados pelo identificador do evento.
Durante quanto tempo é conservado o registo?
7 dias, com o estado, o código HTTP, o número de tentativas e o conteúdo de cada envio.
Quantos endereços posso declarar?
Até 25 por organização, cada um com o seu próprio segredo, que pode renovar.
Um teste no editor de workflows envia um evento?
Não. Só os processamentos reais enviam eventos.
O seu próximo produto
merece mais do que copiar e colar.
Dê à sua equipa de IA os primeiros produtos para trabalhar.
Marcus
Amazon