Webhooks

Webhooks: dina verktyg får besked så fort en körning är klar.

När berikningen eller genereringen av en batch slutförs, misslyckas eller stoppas skickar Upsellr en signerad händelse till den adress du väljer. Ditt verktyg tar över: publicering, granskning, export.

Kategori
API
Riktning
Utskick av händelser
Format
JSON signerad med HMAC-SHA256
Adresser
Upp till 25 per organisation
Nya försök
Upp till 6 försök, under mer än ett dygn
Kom igång
En HTTPS-adress och en hemlig nyckel
Planer
Planen Enterprise
Utgivare
Upsellr

01Vad webhooks gör

Signalen som för dina verktyg framåt.

  1. 01

    En händelse när varje körning är klar

    Slutförd, misslyckad eller stoppad: när varje berikning eller generering är klar skickar Upsellr händelsen med körningens detaljer.

  2. 02

    Signerad, så att den kan verifieras

    Varje leverans har ett ID, en tidsstämpel och en HMAC-SHA256-signatur beräknad med din hemliga nyckel: ditt verktyg kontrollerar att den verkligen kommer från Upsellr.

  3. 03

    Skickas om tills den tas emot

    Utan ett 2xx-svar inom 10 sekunder försöker Upsellr igen efter 1 minut, 5 minuter, 30 minuter, 4 timmar och sedan 24 timmar.

  4. 04

    En logg över varje leverans

    Status, HTTP-kod, antal försök och innehåll: varje leverans kan granskas i 7 dagar, och en misslyckad leverans skickas om med ett klick.

  5. 05

    Koppla ihop dina verktyg

    Publicera, meddela ett team eller starta en export så fort sidorna är klara: webhooken ger signalen, ditt verktyg gör resten.

  6. 06

    Behåll kontrollen

    Inaktivera en adress, byt dess hemliga nyckel eller ta bort den: dess väntande nya försök avbryts.

02Kom igång

Kopplat på några minuter.

  1. 01

    Öppna organisationens inställningar

    Avsnittet API och webhooks, förbehållet ägare och administratörer.

  2. 02

    Lägg till en adress

    En HTTPS-URL som kan nås från internet.

  3. 03

    Kopiera den hemliga nyckeln

    Den visas bara en gång och används för att verifiera signaturen för varje leverans.

  4. 04

    Verifiera signaturen

    Räkna om HMAC-SHA256-signaturen för tidsstämpeln och innehållet, och avvisa en leverans som är för gammal.

  5. 05

    Svara snabbt

    Ett 2xx-svar inom 10 sekunder, hantera sedan resten på din sida.

03Händelser

Händelserna som skickas.

HändelseSkickasSkickas om vid behov
Körning slutförd (workflow.run.completed)JaJa
Körning misslyckad (workflow.run.failed)JaJa
Körning stoppad (workflow.run.stopped)JaJa

Kompatibilitet och krav

  • Planen Enterprise
  • En publik HTTPS-adress, på port 443
  • En ägar- eller administratörsroll
  • Ett 2xx-svar inom 10 sekunder
  • Tips: deduplicera på händelse-ID:t

Du har kontrollen

Pålitliga från grunden.

  • Signerade med HMAC-SHA256, med en egen hemlig nyckel per adress
  • Levereras minst en gång: deduplicera på händelse-ID:t
  • Skickas om upp till 6 gånger, under mer än ett dygn
  • Skickas via HTTPS, endast till publika adresser

04Frågor

Frågor om Upsellrs webhooks.

Ingår webhooks i min plan?

De är förbehållna planen Enterprise, precis som API:et.

Vilka händelser skickas?

Slutet på en berikning eller generering: slutförd, misslyckad eller stoppad. Varje händelse innehåller körningens detaljer.

Hur kontrollerar jag att en leverans kommer från Upsellr?

Räkna om HMAC-SHA256-signaturen för tidsstämpeln och innehållet med din hemliga nyckel, jämför den med headern X-Upsellr-Signature och avvisa leveranser som är äldre än 5 minuter.

Vad händer om min server inte svarar?

Utan ett 2xx-svar inom 10 sekunder försöker Upsellr igen efter 1 minut, 5 minuter, 30 minuter, 4 timmar och sedan 24 timmar. En misslyckad leverans kan också skickas om manuellt från loggen.

Kan jag få samma händelse två gånger?

Ja, det kan hända: leveransen garanteras minst en gång, utan garanterad ordning. Deduplicera på händelse-ID:t.

Hur länge sparas loggen?

7 dagar, med status, HTTP-kod, antal försök och innehåll för varje leverans.

Hur många adresser kan jag lägga till?

Upp till 25 per organisation, var och en med en egen hemlig nyckel som du kan förnya.

Skickar ett test i arbetsflödesredigeraren en händelse?

Nej. Bara riktiga körningar skickar händelser.

Din nästa produkt
förtjänar mer än kopiera och klistra.

Ge ditt AI-team de första produkterna att arbeta med.