Webhooks

Webhooks are automated messages generated by your scoopa platform to notify an external service about the availability of a new file.

You can define multiple webhooks for multiple folders, giving you the ability to integrate third-party services into your scoopa-workflows.

Webhooks are sent as an HTTP POST request to the URL you specify. Information about the new file is included in the request such as File-Name, Size and the Download-URL.
Third-Party Integrators can use this information to download new files directly from our storage into their system.

Managing webhooks

Start creating your first webhook by navigating to "Automations" -> "Webhooks" -> "Add Webhook".

In the popup, enter a name to identify your new webhook as well as the provided URL from your external provider and hit save.

After hitting "Save" you will be redirected to the webhook overview where you should see a checkmark behind your newly webhook. This means the connection has been tested and is valid. (Meaning the provided url returned a 200 HTTP Code). Please note that the webhook is not active yet.

Click on the newly created webhook to edit the webhook and assign folders to which the webhook should react.

If needed you can add addiotional headers that your external provider may require. For example: Credentials needed to authenticate the scoopa-webhook against your external provider.

You can either select folders for which the webhook should be applied or you can choose "all folders".

For each new file in the selected folders (or every folder), the webhook will be called. (see below for a dummy payload of the data trasnmitted).

Forthermore it is possible to limit webhooks by a filter-value. The webhool will only be called if the filename contains the filter-value.

In the edit view you can also trigger a re-validation of your webhook by pressing "Re-Validate Webhook".

You can also delete existing Webhooks by clicking the delete icon in the overview. As with all delete operations this has to be confirmed.

Webhook Call-Logs

You can monitor all running and processed webhook-calls in the "Webhook-Call-Logs" section.

Besides the overall status of the calls, the source-file and target url you can also see the date of the call. If there is an error you can also see the error message here. It is also logged if the call originated from a folder or if it was a platform-wide webhook. An optional applied filter for the webhook is also logged.

Downtime of external API

In the event that a webhool could not reach the external url from your provider on the first try, scoopa will try again after 1min, 10min and 20min before ultimately failing the call.

Webhook Dummy-Payload

Webhooks from scoopa are always POST calls and carry a JSON Body with the following data:

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

The download_url is valid for 24h.

Validation-Calls to the webhook URL

Please be aware that scoopa is calling the webhook in order to validate the URL from time to time.

When implementing a scoopa webhook with your partner it must be considered to ignore those calls.

You can detect those calls by checking the "origin" value in the json body for the value "scoopa - endpoint validation test"

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