Webhooks
Ein Webhook ist ein Tool, mit dem Sie ein Ereignis in Paligo einstellen können, um Ereignisse in einer anderen Anwendung auszulösen. Dies ist nur möglich, wenn die andere Anwendung ebenfalls Webhooks unterstützt. Sie können beispielsweise einen Webhook verwenden, um ein Ticket in JIRA zu aktualisieren, wenn eine Paligo-Publikation veröffentlicht wird.
Derzeit unterstützt Paligo Webhooks für folgende Ereignisse:
Status einer Ressource auf Freigegeben gesetzt
Publikation Veröffentlicht
Auftrag erstellt
Status einer Ressource auf in Übersetzung gesetzt
Status einer Ressource auf in Prüfung gesetzt
Paligo sendet Informationen ähnlich einer Benachrichtigung. Sie enthält grundlegende Informationen wie die ID der Publikation oder des Topics, den Titel, ggf. den Namen der Vorlage und die Art des Ereignisses, das in Paligo stattgefunden hat. Die Informationen werden als JSON an eine URL gesendet, die Sie für die externe Anwendung angeben. Ihre Entwickler müssen Ihre externe Anwendung so konfigurieren, dass sie die Webhook-Daten empfängt und verwendet.
So erstellen Sie einen Webhook:
Stellen Sie Ihre externe Anwendung so ein, dass sie Webhooks empfängt. Paligo kann nur Updates an Anwendungen senden, die Webhooks zulassen.
Eine Anleitung finden Sie in der offiziellen Dokumentation der Anwendung.
Sie benötigen folgende Informationen über Ihre externe Anwendung:
URL zum Empfangen von Webhooks von Paligo
Anmeldedaten (falls Anmeldung erforderlich).
Paligo unterstützt OAuth-Anmeldungen und einfache Anmeldungen (Benutzername und Passwort).
Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:
Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.
Wählen Sie den Avatar in der oberen rechten Ecke aus.
Wählen Sie im Menü Einstellungen aus.
Wählen Sie die Registerkarte Integrationen und Webhooks.
Wählen Sie die Registerkarte Webhooks.
Erstellen Sie mit Webhook hinzufügen einen neuen Webhook.
Alternativ können Sie einen vorhandenen Webhook bearbeiten. Wählen Sie das Punkte-Menü (...) für den Webhook aus und wählen Sie dann Bearbeiten.
Paligo zeigt das Dialogfeld „Webhook hinzufügen“ oder „Webhook“ bearbeiten an. Die beiden Dialogfelder enthalten die gleichen Einstellungen.
Geben Sie den Webhook-Namen ein.
Geben Sie ihm einen aussagekräftigen Namen, durch den andere Benutzer seinen Zweck leicht verstehen können.
Geben Sie die Webhook-URL ein.
Dies ist die Zieladresse Ihrer externen Anwendung für den Webhook.
Geben Sie eine Webhook-Beschreibung ein [optional].
Geben Sie eine aussagekräftige Beschreibung des Webhooks ein, damit andere Benutzer den Zweck des Webhooks leicht verstehen können.
Wählen Sie die Art der Authentifizierung aus, die für die Anmeldung bei der externen Anwendung erforderlich ist.
Keine
OAuth
Wenn Sie OAuth auswählen, müssen Sie auch das Token eingeben.
Einfach
Wenn Sie Einfach auswählen, müssen Sie auch den Benutzernamen und das Passwort eingeben.
Verwenden Sie Ereignisse weiterleiten, um auszuwählen, wann Paligo einen Webhook verwendet, um die andere Anwendung zu kontaktieren.
Es gibt die folgenden Optionen:
Status auf „Freigegeben“ gesetzt
Publikation veröffentlicht
Auftrag erstellt
Status auf „in Übersetzung“ gesetzt
Status auf „in Prüfung“ gesetzt
Anmerkung
Sie können ein Ereignis, mehrere Ereignisse oder keine Ereignisse auswählen. Es kann hilfreich sein, keine Ereignisse auszuwählen, wenn Sie die Webhook-Konfiguration beibehalten, aber keine Ereignisse auslösen möchten; so zum Beispiel, wenn Sie Webhooks zur zukünftigen Verwendung einrichten.
Um eine Vorstellung davon zu erhalten, welche Informationen Paligo versendet, schauen Sie sich die Seite Payloads an.
Wählen Sie Webhook testen, um zu prüfen, ob Paligo den Webhook erfolgreich verwenden kann.
Die Informationen im Abschnitt Payloads geben Ihnen eine Vorstellung davon, welche Informationen Paligo versendet.
Fügen Sie mit Webhook hinzufügen Ihren neuen Webhook hinzu.
Konfigurieren Sie Ihre externe Anwendung so, dass sie die Informationen verwendet, die Paligo als Webhook sendet. Das Beispiel im Webhook-Editor von Paligo gibt Ihnen eine Vorstellung davon, welche Informationen Paligo versendet.
Eine Anleitung finden Sie in der offiziellen Dokumentation der Anwendung.
So bearbeiten Sie einen vorhandenen Webhook:
Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:
Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.
Wählen Sie den Avatar in der oberen rechten Ecke aus.
Wählen Sie im Menü Einstellungen aus.
Wählen Sie die Registerkarte Integrationen und Webhooks.
Wählen Sie die Registerkarte Webhooks.
Suchen Sie den Webhook, den Sie bearbeiten möchten, wählen Sie sein Punkte-Menü (...) aus und wählen Sie dann Bearbeiten.
Bearbeiten Sie den Webhook.
Wählen Sie Webhook bearbeiten, um Ihre Änderungen zu speichern.
So entfernen Sie einen nicht mehr benötigten Webhook:
Rufen Sie in Paligo die Registerkarte Integrationen oder Integrationen und Webhooks auf:
Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.
Wählen Sie den Avatar in der oberen rechten Ecke aus.
Wählen Sie im Menü Einstellungen aus.
Wählen Sie die Registerkarte Integrationen und Webhooks.
Wählen Sie die Registerkarte Webhooks.
Suchen Sie den Webhook, den Sie entfernen möchten, wählen Sie sein Punkte-Menü (...) aus und wählen Sie dann Löschen.
Wählen Sie Löschen, um zu bestätigen, dass Sie den Webhook entfernen möchten.