Webhooks

En webkrok är ett HTTP-anrop som aktiveras av en händelse. Du kan använda webhooks för att aktivera snabbutlösarmoduler. Alla program som är anslutna till Internet och som tillåter HTTP-begäranden kan skicka webbböcker till Adobe Workfront Fusion.

Åtkomstkrav

Använda en webkrok i Workfront Fusion

Så här använder du en webkrok för att ansluta en app till Workfront Fusion:

När du har skapat en webbkrok visas en unik URL. Det här är adressen som webbhoven skickar data till. Workfront Fusion validerar de data som skickas till den här adressen och skickar dem sedan för behandling i scenariot.

Konfigurera webbhakens datastruktur configure-the-webhook-s-data-structure

För att identifiera datastrukturen för inkommande nyttolast tolkar Workfront Fusion exempeldata som du skickar till den visade adressen. Du kan ange exempeldata genom att göra en ändring i tjänsten eller appen som får tjänsten eller appen att anropa webbkroken. Du kan till exempel ta bort en fil.

Du kan också skicka exempeldata via modulen HTTP > Make a request:

Webkrok-kön

Om en webkrok tar emot data och det inte finns något aktivt scenario som förväntar sig dessa data, lagras data i kön. När du har aktiverat scenariot bearbetas alla paket som väntar i kön sekventiellt.

Inkommande dataformat som stöds

Workfront Fusion stöder tre inkommande dataformat: Query String, Form Data och JSON.

Workfront Fusion validerar alla inkommande data mot den valda datastrukturen. Beroende på inställningarna för scenariot lagras data antingen i kön för bearbetning eller bearbetas omedelbart.

Om någon del av informationen inte godkänns vid valideringen returnerar Workfront Fusion en HTTP-statuskod på 400 och anger, i HTTP-svarets brödtext, varför inkommande data inte klarade valideringskontrollerna. Om valideringen av inkommande data lyckas returnerar Workfront Fusion statusen 200 Accepted.

Query String

GET https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>?name=<yourname>&job=automate

Form Data

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>

Content-Type: application/x-www-form-urlencoded

name=<yourname>&job=automate

Multipart-formulärdata

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>


Content-Type: multipart/form-data; boundary=---generatedboundary

---generatedboundary

Content-Disposition: form-data; name="file"; filename="file.txt"


Content-Type: text/plain


Content of file.txt


---generatedboundary

Content-Disposition: form-data; name="name"

Workfront Fusion

---generatedboundary

För att kunna ta emot filer som är kodade med multipart/form-data måste du konfigurera en datastruktur med ett collection-typfält som innehåller de kapslade fälten name, mime och data. Fältet name är av typen text och innehåller namnet på den överförda filen. mime är en text-typ och innehåller en fil i MIME-format. Fältet data är av typen buffer och innehåller binära data för filen som överförs.

Mer information om MIME-format finns i MIME-moduler.

JSON

POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>

Content-Type: application/json

{"name": "Workfront Fusion", "job": "automate"}

Webkrohuvuden

Aktivera Hämta begäranderubriker när du konfigurerar webkroken om du vill få åtkomst till webbhakens sidhuvuden.

Du kan extrahera ett visst rubrikvärde med kombinationen av funktionerna map() och get().

INFO

Exempel:

I exemplet nedan visas en formel som extraherar värdet för huvudet authorization från arrayen Headers[]. Formeln används i ett filter som jämför det extraherade värdet med den angivna texten för att skicka endast webhooks om det finns en matchning.

Mer information om hur du hämtar en arrays element med en viss nyckel finns i Mappa en arrays element med en viss nyckel i artikeln Mappa en array.

Svara på webhooks

Standardsvaret på ett webkrok-anrop är texten"Godkänd". Svaret returneras till appen som anropade webkroken när den anpassade webkrosmodulen kördes.

Testa svaret på en webkrok

Om du vill anpassa webkroks svar ska du använda modulen Webkrok Response.

Modulens konfiguration innehåller två fält: Status och Body.

Tidsgränsen för att skicka ett svar är 40 sekunder. Om svaret inte är tillgängligt inom den perioden returnerar Workfront Fusion statusen"200 Accepted".

Exempel på HTML-svar

INFO

Exempel:

Konfigurera modulen Webhook Response enligt följande:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Status	2xx lyckad HTTP-statuskod, t.ex. 200
Body	HTML code
Custom headers	> > Nyckel: Innehållstyp > Värde: text/html >

Detta ger ett HTML-svar som visas i en webbläsare:

Exempel på omdirigering

INFO

Exempel: Konfigurera modulen Webhook Response enligt följande:

table 0-row-2 1-row-2 layout-auto html-authored no-header
Status	3 x omdirigerings-HTTP-statuskod, t.ex. 303
Custom headers	> > Key: Plats > Value: Den URL som du vill omdirigera till. >

Webkroks-inaktivering

Webhooks inaktiveras automatiskt om något av följande gäller:

Inaktiverade webhooks tas bort och avregistreras automatiskt om de inte är anslutna till några scenarier och har inaktiverats i över 30 dagar.

Felsökning

Saknade objekt på mappningspanelen

Om några objekt saknas i mappningspanelen i inställningarna för modulerna efter modulen Webhooks > Custom Webhook klickar du på modulen Webhooks>Custom Webhook för att öppna dess inställningar och sedan på Re-determine data structure:

Följ sedan de steg som beskrivs i avsnittet Konfigurera webkrockens datastruktur i den här artikeln.