Webhooks

Webhooks sind automatische Nachrichten, die von Ihrer scoopa-Plattform generiert werden, um einen externen Dienst über die Verfügbarkeit einer neuen Datei zu informieren.

Sie können mehrere Webhooks für mehrere Ordner definieren und haben so die Möglichkeit, Dienste von Drittanbietern in Ihre scoopa-Workflows zu integrieren.

Webhooks werden als HTTP POST-Anfrage an die von Ihnen angegebene URL gesendet. Die Anfrage enthält Informationen über die neue Datei, wie z. B. den Dateinamen, die Größe und die Download-URL.
Integratoren von Drittanbietern können diese Informationen nutzen, um neue Dateien direkt aus unserem Speicher in ihr System herunterzuladen.

Verwalten von Webhooks

Beginnen Sie mit der Erstellung Ihres ersten Webhooks, indem Sie zu "Automationen" -> "Webhooks" -> "Add Webhook" navigieren.

Geben Sie im Popup-Fenster einen Namen ein, um Ihren neuen Webhook zu identifizieren, sowie die von Ihrem externen Anbieter bereitgestellte URL.

Bei Bedarf können Sie weitere Request-Header hinzufügen, die Ihr externer Anbieter möglicherweise benötigt. Zum Beispiel: Anmeldeinformationen, die für die Authentifizierung des scoopa-webhook gegenüber Ihrem externen Anbieter erforderlich sind.

Nachdem Sie auf "Speichern" geklickt haben, werden Sie zur Webhook-Übersicht weitergeleitet, wo Sie ein Häkchen hinter Ihrem neuen Webhook sehen sollten. Dies bedeutet, dass die Verbindung getestet wurde und gültig ist. (Das bedeutet, dass die angegebene URL einen 200 HTTP-Code zurückgegeben hat).

Klicken Sie auf den neu erstellten Webhook, um den Webhook zu bearbeiten und Ordner zuzuweisen, auf die der Webhook reagieren soll.

Für jede neue Datei in den ausgewählten Ordnern wird der Webhook aufgerufen. (siehe unten für eine Dummy-Payload der übertragenen Daten).

In der Bearbeitungsansicht können Sie auch eine erneute Validierung Ihres Webhooks auslösen, indem Sie auf "Re-Validate Webhook" klicken.

Sie können bestehende Webhooks auch löschen, indem Sie in der Übersicht auf das Löschsymbol klicken. Wie bei allen Löschvorgängen muss dies bestätigt werden.

Webhook Call-Logs

Sie können alle laufenden und verarbeiteten Webhook-Aufrufe im Bereich "Webhook-Call-Logs" überwachen.

Neben dem Gesamtstatus der Aufrufe, der Quelldatei und der Ziel-URL können Sie auch das Datum des Aufrufs sehen. Wenn ein Fehler auftritt, können Sie hier auch die Fehlermeldung sehen.

Ausfallzeit einer externen API

Falls ein Webhook die externe URL Ihres Providers nicht beim ersten Versuch erreichen konnte, versucht scoopa es nach 1 Minute, 10 Minuten und 20 Minuten erneut, bevor es den Call endgültig abbricht.

Webhook Dummy-Payload

Webhooks von scoopa sind immer POST-Aufrufe und enthalten einen JSON-Body mit den folgenden Daten:

{
  "origin": "scoopa",
  "platform": „test | mediapool",
  "file_id": 535986,
  "file_name": "server_push.svg",
  "file_size_in_bytes": 5007,
  "folder_id": 62251,
  "folder_name": "Test Webhook",
  "download_url": "https://....."
}

Die download_url ist 24 Stunden lang gültig.

Validierung-Aufrufe an die Webhook-URL

Bitte beachten Sie, dass scoopa den Webhook aufruft, um die URL von Zeit zu Zeit zu validieren.

Wenn Sie einen scoopa-Webhook bei Ihrem Partner implementieren, müssen Sie darauf achten, dass diese Anrufe ignoriert werden.

Sie können diese Aufrufe erkennen, indem Sie den Wert "origin" im json-Body auf den Wert "scoopa - endpoint validation test" überprüfen

{
  "origin": "scoopa - endpoint validation test",
  "platform": „test | mediapool",
  "file_id": "12345",
  "file_name": "test.mov",
  "file_size_in_bytes": "1048576",
  "folder_id": "67890",
  "folder_name": "test-folder",
  "download_url": "https://....."
}