Webhooks

Ein Webhook ist ein HTTP-Aufruf, der von einem Ereignis ausgelöst wird. Sie können Webhooks verwenden, um Instant Trigger-Module zu aktivieren. Jede Anwendung, die mit dem Internet verbunden ist und HTTP-Anfragen zulässt, kann Webhooks an Adobe Workfront Fusion senden.

Zugriffsanforderungen

Verwenden eines Webhooks in Workfront Fusion

So verwenden Sie einen Webhook, um eine App mit Workfront Fusion zu verbinden:

Nachdem Sie einen Webhook erstellt haben, wird eine eindeutige URL angezeigt. Dies ist die Adresse, an die der Webhook Daten sendet. Workfront Fusion validiert die an diese Adresse gesendeten Daten und gibt sie dann zur Verarbeitung im Szenario weiter.

Konfigurieren der Datenstruktur des Webhooks configure-the-webhook-s-data-structure

Um die Datenstruktur der eingehenden Payload zu erkennen, analysiert Workfront Fusion Beispieldaten, die Sie an die angezeigte Adresse senden. Sie können die Beispieldaten bereitstellen, indem Sie den Service oder die App ändern, damit dieser Service oder diese App den Webhook aufruft. Sie können beispielsweise eine Datei entfernen.

Sie können die Beispieldaten auch über das Modul HTTP > Make a request senden:

Die Webhook-Warteschlange

Wenn ein Webhook Daten empfängt und kein aktives Szenario diese Daten erwartet, werden die Daten in der Warteschlange gespeichert. Nachdem Sie das Szenario aktiviert haben, werden alle Pakete, die in der Warteschlange warten, sequenziell verarbeitet.

Unterstützte eingehende Datenformate

Workfront Fusion unterstützt 3 eingehende Datenformate: Query String, Form Data und JSON.

Workfront Fusion validiert alle eingehenden Daten anhand der ausgewählten Datenstruktur. Anschließend werden die Daten je nach den Einstellungen des Szenarios entweder zur Verarbeitung in der Warteschlange gespeichert oder sofort verarbeitet.

Wenn ein Teil der Daten die Validierung nicht besteht, gibt Workfront Fusion einen 400-HTTP-Status-Code zurück und gibt im Hauptteil der HTTP-Antwort den Grund an, warum die eingehenden Daten bei den Validierungsprüfungen fehlgeschlagen sind. Wenn die Validierung der eingehenden Daten erfolgreich ist, gibt Workfront Fusion den Status "200 Accepted" zurück.

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

Mehrteilige Formulardaten

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

Um mit multipart/form-data codierte Dateien zu erhalten, müssen Sie eine Datenstruktur mit einem Feld vom Typ collection konfigurieren, das die verschachtelten Felder name, mime und data enthält. Das Feld name ist ein text und enthält den Namen der hochgeladenen Datei. Der mime ist ein text und enthält eine Datei im MIME-Format. Das Feld data ist vom buffer Typ und enthält Binärdaten für die übertragene Datei.

Weitere Informationen zum MIME-Format finden Sie unter MIME-Module.

JSON

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

Content-Type: application/json

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

Webhook-Kopfzeilen

Um auf die Kopfzeilen des Webhooks zuzugreifen, aktivieren Sie beim Einrichten des Webhooks die Option GET-Anfrage-Kopfzeilen .

Sie können einen bestimmten Kopfzeilenwert mit der Kombination aus map()- und get() extrahieren.

INFO

Beispiel:

Das folgende Beispiel zeigt eine Formel, die den Wert der authorization-Kopfzeile aus dem Headers[]-Array extrahiert. Die Formel wird in einem Filter verwendet, der den extrahierten Wert mit dem angegebenen Text vergleicht, damit nur Webhooks übergeben werden, wenn eine Übereinstimmung vorliegt.

Weitere Informationen zum Abrufen eines Array-Elements mit einem bestimmten Schlüssel finden Sie unter Zuordnen eines Array-Elements mit einem bestimmten Schlüssel im Artikel Zuordnen eines Arrays .

Reagieren auf Webhooks

Die Standardantwort auf einen Webhook-Aufruf ist der Text „Accepted“. Die Antwort wird an die App zurückgegeben, die den Webhook während der Ausführung des benutzerdefinierten Webhook-Moduls aufgerufen hat.

Testen der Antwort auf einen Webhook

Wenn Sie die Webhook-Antwort anpassen möchten, verwenden Sie das Modul Webhook-Antwort .

Die Konfiguration des Moduls enthält zwei Felder: Status und Body.

Die maximale Wartezeit für das Senden einer Antwort beträgt 40 Sekunden. Wenn die Antwort innerhalb dieses Zeitraums nicht verfügbar ist, gibt Workfront Fusion den Status „200 akzeptiert“ zurück.

Beispiel einer HTML-Antwort

INFO

Beispiel:

Konfigurieren Sie das Webhook Response wie folgt:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Status	2xx Erfolgs-HTTP-Status-Code, z. B. 200
Body	HTML
Custom headers	> > key: Content-Type > Wert: text/html >

Dadurch wird eine HTML-Antwort erzeugt, die in einem Webbrowser angezeigt wird:

Redirect-Beispiel

INFO

Beispiel Konfigurieren Sie das Webhook Response wie folgt:

table 0-row-2 1-row-2 layout-auto html-authored no-header
Status	3xx HTTP-Status-Code der Weiterleitung, z. B. 303
Custom headers	> > Key: Speicherort > Value: Die URL, zu der Sie umleiten möchten. >

Webhook-Deaktiviert

Webhooks werden automatisch deaktiviert, wenn einer der folgenden Punkte zutrifft:

Deaktivierte Webhooks werden automatisch gelöscht und von der Registrierung entfernt, wenn sie mit keinem Szenario verbunden sind und sich seit mehr als 30 Tagen im Status Deaktiviert befinden.

Fehlerbehebung

Fehlende Elemente im Zuordnungsbereich

Wenn einige Elemente im Bedienfeld Zuordnung bei der Einrichtung der Module fehlen, die dem Modul Webhooks > Custom Webhook folgen, klicken Sie auf das Modul Webhooks>Custom Webhook , um das Modul zu öffnen, und klicken Sie auf Re-determine data structure:

Führen Sie dann die Schritte aus, die im Abschnitt Konfigurieren der Datenstruktur des Webhooks in diesem Artikel beschrieben sind.