Ta emot webhooks när ett workflow är klart

Webhooks meddelar dina system när en workflow-körning är klar. Upsellr skickar då en förfrågan till den adress du väljer. De ingår i planen Enterprise.

Händelserna

Händelse	När den skickas
workflow.run.completed	En körning avslutas utan fel
workflow.run.failed	En körning misslyckas
workflow.run.stopped	En användare stoppar en körning

Varje utskick innehåller den fullständiga representationen av körningen, i samma format som det publika API:et. Fliken Event catalogue beskriver formatet.

Lägga till en endpoint

1. Öppna kontomenyn och sedan Manage och API & webhooks.
2. På fliken Endpoints, klicka på Add endpoint.
3. Fyll i ett Name och Endpoint URL. Bara publika HTTPS-adresser accepteras: privata nätverk och omdirigeringar blockeras.
4. Kryssa i Events to receive och spara sedan.
5. Kopiera signeringshemligheten. Den visas bara en gång.

En endpoint kan pausas och sedan återaktiveras. Om du tappar bort hemligheten, klicka på Rotate secret och uppdatera din mottagare direkt.

Verifiera signaturen

Varje utskick har två rubriker: X-Upsellr-Timestamp, utskickets tidsstämpel, och X-Upsellr-Signature, i formen v1= följt av en hexadecimal hash med gemener. Hashen är en HMAC-SHA256, beräknad med endpointens hemlighet, på tidsstämpeln, en punkt och sedan förfrågans råa innehåll.

Verifiera signaturen på det råa innehållet, innan du avkodar JSON. Jämför signaturerna i konstant tid och avvisa för gamla tidsstämplar.

Utskick och nya försök

• Händelserna skickas som JSON, med en POST-förfrågan. Varje 2xx-svar bekräftar mottagandet.
• Vid misslyckande försöker Upsellr igen efter 1 minut, 5 minuter, 30 minuter, 4 timmar och 24 timmar.
• En händelse kan komma fram mer än en gång, och ordningen garanteras inte: deduplicera med händelsens ID.

Leveransloggen

Fliken Event deliveries listar utskicken under de senaste 7 dagarna, med deras status, försök och innehåll. För ett misslyckat utskick, klicka på Replay failed delivery: samma händelse skickas igen, med samma ID.

Bra att veta

• Bara ägare och administratörer hanterar endpoints och skickar om utskick.
• Att ta bort en endpoint avbryter dess väntande utskick. Befintliga loggar behålls.