Webhooks

Ein Webhook ist ein HTTP-Aufruf, der durch ein 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

Sie müssen über den folgenden Zugriff verfügen, um die in diesem Artikel enthaltene Funktionalität nutzen zu können:

*Wenden Sie sich an Ihren Workfront-Administrator, um zu erfahren, welchen Plan, welchen Lizenztyp oder welchen Zugriff Sie haben.

**Informationen über Adobe Workfront Fusion Lizenzen, siehe Adobe Workfront Fusion Lizenzen

Verwenden Sie einen Webhook in Workfront Fusion

So verbinden Sie eine App über einen Webhook mit Workfront Fusion:

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.

Datenstruktur des Webhooks konfigurieren configure-the-webhook-s-data-structure

Um die Datenstruktur der eingehenden Payload zu erkennen, Workfront Fusion analysiert Beispieldaten, die Sie an die angezeigte Adresse senden. Sie können die Beispieldaten bereitstellen, indem Sie eine Änderung im Dienst oder in der App vornehmen, die dazu führt, dass dieser Dienst oder diese App den Webhook aufruft. Sie können beispielsweise eine Datei entfernen.

Sie können auch die folgenden Schritte ausführen, um die Beispieldaten über die HTTP > Anfrage stellen -Modul.

Warteschlange

Wenn ein Webhook Daten erhält und kein aktives Szenario mit diesen Daten verbunden ist, werden die Daten in der Warteschlange gespeichert. Nachdem Sie das Szenario aktiviert haben, werden alle Pakete, die in der Warteschlange warten, nacheinander verarbeitet.

Unterstützte eingehende Datenformate

Workfront Fusion unterstützt 3 eingehende Datenformate: Abfragezeichenfolge, Formulardaten und JSON.

Workfront Fusion validiert alle eingehenden Daten mit 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, Workfront Fusion gibt einen 400-HTTP-Status-Code zurück und gibt im Text 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 einen "200 Angenommen".

Abfragezeichenfolge

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

Formulardaten

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

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

name=<yourname>&job=automate

Formulardaten mit mehreren Elementen

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 den Empfang von Dateien, die mit multipart/form-data, müssen Sie eine Datenstruktur mit einer collection Typfeld, das die verschachtelten Felder enthält name, mimeund data. Das Feld name ist text und enthält den Namen der hochgeladenen Datei. Die mime ist text und enthält eine Datei im MIME-Format. Das Feld data ist buffer und enthält Binärdaten für die zu übertragende 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-Header

Um auf die Header des Webhooks zuzugreifen, aktivieren Sie beim Einrichten des Webhooks die Option Anforderungsheader abrufen .

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

INFO

Beispiel:

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

Weitere Informationen zum Abrufen des Elements eines Arrays mit einem bestimmten Schlüssel finden Sie unter Element eines Arrays mit einem bestimmten Schlüssel zuordnen im Artikel Informationen in Adobe Workfront Fusion von einem Modul zum anderen zuordnen.

Antworten auf Webhooks

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

Testen der Antwort auf einen Webhook

Wenn Sie die Webhook-Antwort anpassen möchten, wenden Sie das Modul Webhook Response an.

Die Konfiguration des Moduls umfasst zwei Felder: Status und body.

Die Zeitüberschreitung 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.

HTML-Antwortbeispiel

INFO

Beispiel:

Konfigurieren Sie die Webhook-Antwort -Modul wie folgt:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Status	2xx Erfolg HTTP-Status-Code, z. B. 200
Body	HTML-Code
Benutzerdefinierte Kopfzeilen	> > Schlüssel: Inhaltstyp > Wert: text/html >

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

Beispiel einer Umleitung

INFO

Beispiel: Konfigurieren Sie die Webhook-Antwort -Modul wie folgt:

table 0-row-2 1-row-2 layout-auto html-authored no-header
Status	3xx-Weiterleitungs-HTTP-Status-Code, z. B. 303
Benutzerdefinierte Kopfzeilen	> > Schlüssel: Standort > Wert: Die URL, zu der Sie umleiten möchten. >

Webhook-Deaktivierung

Webhooks werden automatisch deaktiviert, wenn eine der folgenden Aktionen zutrifft:

Deaktivierte Webhooks werden automatisch gelöscht und abgemeldet, wenn sie mit keinem Szenario verbunden sind und seit über 30 Tagen den Status deaktiviert haben.

Fehlerbehebung

Fehlende Elemente im Zuordnungsbereich

Wenn einige Elemente im Zuordnungsbereich bei der Einrichtung der Module fehlen, folgen Sie dem Webhooks > Benutzerspezifischer Webhook -Modul, klicken Sie auf die Webhooks > Benutzerspezifischer Webhook -Modul, um seine Einrichtung zu öffnen, und klicken Sie auf Datenstruktur neu bestimmen:

Führen Sie dann die im Abschnitt beschriebenen Schritte aus. Datenstruktur des Webhooks konfigurieren in diesem Artikel.