Webhooks

How you can notify your system on demand

Webhook Support

Webhooks allow our system to notify an external endpoint whenever a file is changed.
You can configure these settings directly in the system preferences.

This makes it easy to integrate file updates into your own workflows or external systems.

Overview of fairu webhooks

How Webhooks Work

Each time a file is modified—such as when it’s saved—or when a copyright status changes,
the system sends a notification to the configured webhook endpoint.

To ensure reliability, the maximum request duration is limited to 10 seconds.
If the endpoint doesn't respond within that time, the webhook request will time out.

Webhook Payload Structure

The structure of the webhook request is always the same.
Here’s an example of the JSON payload sent to your endpoint:

{
  "type": "TYPE_OF_ACTION",
  "id": "ASSET_ID",
  "body": {
    // additional information depending on the action
  }
}

On this page