# Webhooks

#### What are Webhooks?

Webhooks are server-side push notifications that are triggered by specific events within the 3Q platform. They allow external systems to react automatically to changes or actions without the need for polling.

Typical webhook events include:

* A video asset has been uploaded or updated
* A livestream has started or ended
* Processing or encoding states have changed

***

#### Configuration

<figure><img src="/files/HvDjJo7IYD9qPVxtoxHX" alt=""><figcaption></figcaption></figure>

Webhooks can be configured in the **Notifications** module. For each webhook, the following settings can be defined:

* Target URL (endpoint that receives the event)
* Secret for request validation
* Event types to subscribe to

Once configured, the platform sends an HTTP request to the specified endpoint whenever the selected event occurs.

***

#### Example Payload

Webhook requests include event information as URL parameters and a structured JSON payload in the request body.

**Example request URL:**

```
/{path}?ProjectId=105489&FileId=11778933&event=file.new
```

**Example payload:**

```json
[
  {
    "Event": "file.new",
    "ProjectId": 105489,
    "File": {
      "Id": 11778953,
      "Name": "uploads/105489-R4WnjV2PzrXY8yN6dTp9.mp4",
      "IsFinished": true,
      "IsEncoded": true,
      "UseEncoding": true,
      "EncodingPriority": 50,
      "HasErrors": false,
      "Metadata": {
        "StandardFilePicture": {
          "AspectRatio": "1:1",
          "AspectRatioClosest": "1:1",
          "FilePictureId": 13384417,
          "URI": "https://sdn-global-prog-cache.3qsdn.com/105489/files/25/07/28/11778953/483c1dd0-cb5d-4572-80b0-73376a000be3.jpg",
          "ThumbURI": "https://sdn-global-prog-cache.3qsdn.com/105489/files/25/07/28/11778953/c9040770-4129-4fcc-a4c1-3ff6c5aa54f8.jpg",
          "SrcPictureURI": "https://sdn-global-prog-cache.3qsdn.com/105489/files/25/07/28/11778953/7bac5606-9e16-48ee-9560-87c853204dec.jpg",
          "IsStandard": true,
          "ManualUpload": false
        },
        "Title": "Rikscha Quadrat_Intern_1.mp4",
        "Description": "",
        "DisplayTitle": "",
        "DisplayTitleSecondLine": "",
        "ReleaseStatus": "unpublished",
        "Category": [],
        "IABCategory": [],
        "Share": [],
        "Videotype": [],
        "OriginalFileName": "Rikscha Quadrat_Intern_1.mp4",
        "CustomMetadata": {
          "adsDisabled": false
        }
      },
      "CreatedAt": "2025-07-28T12:23:14+00:00",
      "LastUpdateAt": "2025-07-28T12:25:49+00:00"
    }
  }
]
```

***

#### Security

Webhook requests can be secured using **AWS Cognito signature validation**. This allows recipients to verify the authenticity of incoming webhook requests.

AWS Cognito can be connected to the 3Q platform in **Account → Partners & Services**. Once configured, webhook requests will be signed accordingly.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.3q.video/rest-api/webhooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.