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:

Adobe Workfront plan*
Pro of hoger
Adobe Workfront licentie*
Plan, Work
Adobe Workfront Fusion licentie**

Huidige licentievereiste: geen Workfront Fusion licentievereiste.

of

Vereiste voor oudere licenties: Workfront Fusion voor werkautomatisering en integratie

Product

Huidige productvereiste: als u het abonnement Select of Prime Adobe Workfront hebt, moet uw organisatie Adobe Workfront Fusion en Adobe Workfront aanschaffen om de in dit artikel beschreven functionaliteit te kunnen gebruiken. Workfront Fusion wordt opgenomen in het Ultimate Workfront -abonnement.

of

Vereiste verouderd product: uw organisatie moet Adobe Workfront Fusion en Adobe Workfront aanschaffen om de in dit artikel beschreven functionaliteit 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

NOTE
Als u een webhaak van derden (een uitgaande webhaak) wilt aanroepen, gebruikt u een van de HTTP-modules. Voor meer informatie, zie modules van HTTP.

Een webhaak gebruiken om een app te verbinden met Workfront Fusion :

  1. Voeg de Webhooks > Custom Webhook onmiddellijke trekkermodule aan uw scenario toe.

  2. Klik op Add naast het veld Webhaak en voer een naam voor de nieuwe webhaak in.

  3. (Optioneel) Klik op Advanced Settings .

  4. Voer in het veld IP restrictions een door komma's gescheiden lijst in met de IP-adressen waaruit de module gegevens kan accepteren.

  5. 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.

NOTE
Als u een webhaak hebt gemaakt, kunt u deze in meerdere scenario's tegelijk gebruiken.

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.

  1. Een nieuw scenario maken met de module HTTP > Make a request

  2. 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

  3. Open het scenario met de module Webhooks in een afzonderlijk browsertabblad of venster.

  4. Klik in de module Webhooks op Redetermine data structure .

    U hoeft andere modules niet los te koppelen van de module Webhooks.

  5. Schakel over naar het scenario met de module HTTP en voer het uit.

  6. Schakel terug naar het scenario met de module Webhooks.

    Een "Successfully determined"bericht betekent dat de module met succes de gegevensstructuur heeft bepaald.

  7. 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.

IMPORTANT
Webhaak-wachtrijen worden gedeeld door scenario's waarin dezelfde webhaak wordt gebruikt. Als één van de scenario's gehandicapt is, worden alle inkomende gegevens gehouden in de rij.

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"}
TIP
Als u toegang wilt krijgen tot de oorspronkelijke JSON, schakelt u JSON-pass-through in wanneer u de webhaak instelt.
  1. Klik op Add om een nieuwe webhaak toe te voegen.
  2. Klik op Show advanced settings.
  3. 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.

  1. Klik op Add om een nieuwe webhaak toe te voegen.
  2. Klik op Show advanced settings.
  3. Klik op Get request headers.

U kunt een bepaalde headerwaarde extraheren met de combinatie van map() - en get() -functies.

INFO
Voorbeeld:
In het onderstaande voorbeeld ziet u een formule die de waarde van de header 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.
Voor verdere informatie bij het verkrijgen van het element van een serie met een bepaalde sleutel, zie het element van een serie met een bepaalde sleutelin de artikel informatie van de Kaart van één module aan een andere in de Fusie van Adobe Workfrontin kaart brengen.

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

  1. Neem de module Custom Webhook op in uw scenario.

  2. Voeg een nieuwe webhaak aan de module toe.

  3. Kopieer de URL van de webhaak naar het klembord.

  4. 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.

  5. 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 (bijvoorbeeld 307 voor Tijdelijke omleiding), 4xx voor Clientfouten (bijvoorbeeld 400 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

INFO
Voorbeeld:
Configureer de module Webhook Response als volgt:
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

>

  • > Sleutel : Inhoud-type
  • > Waarde : text/html >
Hierdoor wordt een HTML-reactie gegenereerd die in een webbrowser wordt weergegeven:

Voorbeeld van omleiding

INFO
Voorbeeld: vorm de Webhook Response module als volgt:
table 0-row-2 1-row-2 layout-auto html-authored no-header
Status 3xx HTTP-statuscode voor omleiding, bijvoorbeeld 303
Custom headers

>

  • > Key: Locatie
  • > Value: De URL waarnaar u wilt omleiden. >

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.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43