Webhaken
Een webhaak is een HTTP-aanroep die door een gebeurtenis wordt geactiveerd. U kunt webhaken gebruiken om onmiddellijk triggermodules te activeren. Elke toepassing die is verbonden met internet en HTTP-aanvragen toestaat, kan webhooks naar Adobe Workfront Fusion verzenden.
Toegangsvereisten
U moet de volgende toegang hebben om de functionaliteit in dit artikel te kunnen gebruiken:
* om te weten te komen welk plan, vergunningstype, of toegang u hebt, contacteer uw beheerder van Workfront.
** voor informatie over Adobe Workfront Fusion vergunningen, zie Adobe Workfront Fusion vergunningen
Webhaak gebruiken in Workfront Fusion
Een webhaak gebruiken om een app te verbinden met Workfront Fusion :
-
Voeg de Webhooks > Custom Webhook onmiddellijke trekkermodule aan uw scenario toe.
-
Klik op Add naast het veld Webhaak en voer een naam voor de nieuwe webhaak in.
-
(Optioneel) Klik op Advanced Settings .
-
Voer in het veld IP restrictions een door komma's gescheiden lijst in met de IP-adressen waaruit de module gegevens kan accepteren.
-
Klikken Save
Nadat u een webhaak hebt gemaakt, wordt een unieke URL weergegeven. Dit is het adres waar de webhaak gegevens verzendt. Workfront Fusion valideert de gegevens die naar dit adres worden verzonden en geeft deze vervolgens door voor verwerking in het scenario.
De gegevensstructuur van de webhaak configureren configure-the-webhook-s-data-structure
Workfront Fusion parseert voorbeeldgegevens die u naar het weergegeven adres verzendt om de gegevensstructuur van de inkomende lading te herkennen. U kunt de voorbeeldgegevens opgeven door een wijziging aan te brengen in de service of app die ervoor zorgt dat die service of toepassing de webhaak oproept. U kunt bijvoorbeeld een bestand verwijderen.
U kunt ook de onderstaande stappen volgen om de voorbeeldgegevens via de module HTTP > Make a request te verzenden.
-
Een nieuw scenario maken met de module HTTP > Make a request
-
Configureer de module met de volgende waarden:
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header URL Voer de URL van de webhaak in. U vindt deze URL in de module Webhooks die u hebt gebruikt om de webhaak in te stellen. Method POST Body type Raw Content type JSON (application/json) Request content Ruwe JSON verwacht in de webhaak -
Open het scenario met de module Webhooks in een afzonderlijk browsertabblad of venster.
-
Klik in de module Webhooks op Redetermine data structure .
U hoeft andere modules niet los te koppelen van de module Webhooks.
-
Schakel over naar het scenario met de module HTTP en voer het uit.
-
Schakel terug naar het scenario met de module Webhooks.
Een "Successfully determined"bericht betekent dat de module met succes de gegevensstructuur heeft bepaald.
-
Klik op OK om de gegevensstructuur op te slaan.
De items van de webhaak zijn nu beschikbaar in het deelvenster Toewijzing voor gebruik met volgende modules in het scenario.
De webshaakwachtrij
Als een website gegevens ontvangt en er geen actief scenario is dat dat gegevens verwacht, worden de gegevens opgeslagen in de rij. Zodra u het scenario activeert, verwerkt het alle bundels die in de rij opeenvolgend wachten.
Ondersteunde binnenkomende gegevensindelingen
Workfront Fusion ondersteunt 3 binnenkomende gegevensindelingen: Query String , Form Data en JSON .
Workfront Fusion valideert alle binnenkomende gegevens op basis van de geselecteerde gegevensstructuur. Afhankelijk van de instellingen van het scenario worden de gegevens vervolgens in de wachtrij opgeslagen voor verwerking of onmiddellijk verwerkt.
Als een deel van de gegevens niet voor de validatie zorgt, retourneert Workfront Fusion een 400 HTTP-statuscode en wordt in de hoofdtekst van de HTTP-reactie aangegeven waarom de binnenkomende gegevens de validatiecontroles niet hebben doorstaan. Als de bevestiging van de inkomende gegevens slaagt, keert Workfront Fusion "200 Accepted"status terug.
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-formuliergegevens
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
Als u bestanden wilt ontvangen die zijn gecodeerd met multipart/form-data
, moet u een gegevensstructuur configureren met een collection
tekstveld dat de geneste velden name
, mime
en data
bevat. Het veld name
is een text
-type en bevat de naam van het geüploade bestand. mime
is een text
-type en bevat een bestand in de MIME-indeling. Het veld data
is een buffer
-type en bevat binaire gegevens voor het bestand dat wordt overgedragen.
Voor meer informatie over formaat MIME, zie MIME modules.
JSON
POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>
Content-Type: application/json
{"name": "Workfront Fusion", "job": "automate"}
- Klik op Add om een nieuwe webhaak toe te voegen.
- Klik op Show advanced settings.
- Klik op JSON pass-through.
WebHaakkoppen
Als u de koppen van de webhaak wilt openen, schakelt u aanvraagheaders ophalen in wanneer u de webhaak instelt.
- Klik op Add om een nieuwe webhaak toe te voegen.
- Klik op Show advanced settings.
- Klik op Get request headers.
U kunt een bepaalde headerwaarde extraheren met de combinatie van map()
- en get()
-functies.
authorization
extraheert uit de array Headers[]
. De formule wordt gebruikt in een filter dat de geëxtraheerde waarde met de gegeven tekst vergelijkt om slechts webhooks over te gaan als er een gelijke is.Reageren op webhaken
De standaardreactie op een webshaanroep is de tekst "Geaccepteerd". De reactie wordt geretourneerd aan de toepassing die de webhaak heeft aangeroepen tijdens de uitvoering van de aangepaste module Webhaak.
De reactie op een webhaak testen
-
Neem de module Custom Webhook op in uw scenario.
-
Voeg een nieuwe webhaak aan de module toe.
-
Kopieer de URL van de webhaak naar het klembord.
-
Voer het scenario uit.
Het bliksempictogram in de module Custom Webhook verandert in draaiende stippen. Dit toont aan dat de module nu op de webhaakvraag wacht.
-
Open een nieuw browservenster, plak de gekopieerde URL in de adresbalk en druk op Enter .
De module Custom Webhook wordt geactiveerd en de browser geeft een nieuwe pagina weer.
Als u de reactie van de webhaak wilt aanpassen, gebruikt u de module Reactie Webhaak.
De configuratie van de module bevat twee velden: Status en Body .
-
Het veld Status bevat statuscodes voor HTTP-reacties, zoals 2xx voor succes (bijvoorbeeld
200
voor OK), 3xx voor Omleiding (bijvoorbeeld307
voor Tijdelijke omleiding), 4xx voor Clientfouten (bijvoorbeeld400
voor Onjuiste aanvraag), enzovoort. -
Het veld Body bevat alles wat wordt geaccepteerd door de aanroep van de website. Het kan eenvoudige tekst zijn, HTML, XML, JSON enzovoort.
note tip TIP We raden u aan de header Content-Type
in te stellen op het corresponderende MIME-type:text/plain
voor onbewerkte tekst,text/html
voor HTML,application/json
voor JSON,application/xml
voor XML enzovoort. Voor meer informatie over types MIME, zie MIME modules.
De time-out voor het verzenden van een reactie is 40 seconden. Als de reactie niet beschikbaar is binnen die periode, retourneert Workfront Fusion de status '200 Accepted'.
HTML-voorbeeld
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
---|---|
Status | 2xx de statuscode van succesHTTP, b.v. 200 |
Body | HTML-code |
Custom headers |
>
|
Voorbeeld van omleiding
table 0-row-2 1-row-2 layout-auto html-authored no-header | |
---|---|
Status | 3xx HTTP-statuscode voor omleiding, bijvoorbeeld 303 |
Custom headers |
>
|
Webhaak-deactivering
Webhaken worden automatisch gedeactiveerd als een van de volgende twee situaties van toepassing is:
- De webhaak is langer dan 5 dagen niet verbonden met een scenario
- De webhaak wordt alleen gebruikt in inactieve scenario's, die al meer dan 30 dagen inactief zijn.
gedeactiveerde webhaken worden automatisch verwijderd en niet geregistreerd als ze niet zijn aangesloten op scenario's en meer dan 30 dagen in de gedeactiveerde status zijn geweest.
Problemen oplossen
Ontbrekende items in het deelvenster Toewijzing
Als sommige items ontbreken in het deelvenster Toewijzing tijdens het instellen van de modules na de module Webhooks > Custom Webhook , klikt u op de module Webhooks>Custom Webhook om de installatie te openen en klikt u op Re-determine data structure :
Dan volg de stappen die in de sectie worden beschreven vormen de de gegevensstructuur van de webhaakin dit artikel.