Přijímání webhooků po dokončení workflow

Webhooky upozorňují vaše systémy, když zpracování workflow skončí. Upsellr pak odešle požadavek na adresu podle vaší volby. Jsou součástí tarifu Enterprise.

Události

Událost	Kdy se odešle
workflow.run.completed	Zpracování úspěšně skončí
workflow.run.failed	Zpracování selže
workflow.run.stopped	Uživatel zpracování zastaví

Každé odeslání obsahuje úplnou reprezentaci zpracování ve stejném formátu jako veřejné API. Tento formát popisuje záložka Event catalogue.

Přidání endpointu

1. Otevřete nabídku účtu, potom Manage a API & webhooks.
2. Na záložce Endpoints klikněte na Add endpoint.
3. Vyplňte Name a Endpoint URL. Přijímají se jen veřejné adresy HTTPS: privátní sítě a přesměrování jsou blokované.
4. Zaškrtněte Events to receive a uložte.
5. Zkopírujte podpisový klíč (secret). Zobrazí se jen jednou.

Endpoint lze pozastavit a znovu zapnout. Pokud podpisový klíč ztratíte, klikněte na Rotate secret a hned aktualizujte svůj přijímač.

Ověření podpisu

Každé odeslání nese dvě hlavičky: X-Upsellr-Timestamp, časové razítko odeslání, a X-Upsellr-Signature ve tvaru v1= následovaném hexadecimálním otiskem malými písmeny. Otisk je HMAC-SHA256 vypočtený s podpisovým klíčem endpointu z časového razítka, tečky a surového těla požadavku.

Podpis ověřujte na surovém těle, před dekódováním JSON. Podpisy porovnávejte v konstantním čase a příliš stará časová razítka odmítejte.

Odesílání a opakované pokusy

• Události se odesílají jako JSON požadavkem POST. Každá odpověď 2xx potvrzuje přijetí.
• Při selhání to Upsellr zkusí znovu po 1 minutě, 5 minutách, 30 minutách, 4 hodinách a 24 hodinách.
• Událost může dorazit víckrát a pořadí není zaručené: odstraňujte duplicity podle identifikátoru události.

Protokol doručení

Záložka Event deliveries vypisuje odeslání za posledních 7 dní s jejich stavem, pokusy a obsahem. U neúspěšného odeslání klikněte na Replay failed delivery: stejná událost se odešle znovu se stejným identifikátorem.

Dobré vědět

• Endpointy spravují a odeslání znovu přehrávají jen vlastníci a administrátoři.
• Smazání endpointu zruší jeho čekající odeslání. Existující protokoly zůstanou zachovány.