> For the complete documentation index, see [llms.txt](https://docs.ylytic.com/ylytic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ylytic.com/ylytic/webhook/webhook-documentation.md).

# Webhook Documentation

## Webhook Configuration & Endpoint Setup

To enable webhook notifications, clients are required to provide a **POST API endpoint (URL)** where webhook events will be delivered. Once shared, this endpoint is securely configured in the system to send real-time updates whenever the relevant event occurs.

## Third party creator webhook

This webhook is used to notify when creator insights are successfully generated and available for access.

#### Webhook Payload

<table><thead><tr><th width="145.59765625">Field Name</th><th width="212.84375">Description</th><th width="223.10546875">Possible Values</th><th width="157.015625">Sample Value</th></tr></thead><tbody><tr><td><strong>type</strong></td><td>Identifies the webhook event or insights category</td><td> creator_insights</td><td>creator_insights</td></tr><tr><td><strong>status</strong></td><td>Current processing status of the request</td><td><p>success, </p><p>failed</p></td><td> success</td></tr><tr><td><strong>status_reason</strong></td><td>Reason for failure (applicable only when status is failed)</td><td><p>Restricted/Invalid Profile,</p><p>Private Account,</p><p>Invalid Handle</p></td><td>Invalid Handle</td></tr><tr><td><strong>identifier</strong></td><td>Creator handle or unique creator identifier</td><td>-</td><td>minimuffin8888</td></tr><tr><td><strong>connector</strong></td><td>Platform source from which insights are fetched</td><td><p>instagram, </p><p>youtube, </p><p>tiktok, </p><p>facebook</p></td><td>instagram</td></tr></tbody></table>

## First party creator webhook

This webhook is used to notify when first party creator insights are successfully generated and available for access.

#### Webhook Payload

<table><thead><tr><th width="145.59765625">Field Name</th><th width="205.8359375">Description</th><th width="218.08984375">Possible Values</th><th width="171.85546875">Sample Value</th></tr></thead><tbody><tr><td><strong>type</strong></td><td>Identifies the webhook event or insights category</td><td> creator_insights_1p</td><td>creator_insights_1p</td></tr><tr><td><strong>status</strong></td><td>Current processing status of the request</td><td><p>success, </p><p>failed</p></td><td> success</td></tr><tr><td><strong>status_reason</strong></td><td>Reason for failure (applicable only when status is failed)</td><td><p>Restricted/Invalid Profile,</p><p>Private Account,</p><p>Invalid Handle</p></td><td>Invalid Handle</td></tr><tr><td><strong>identifier</strong></td><td>Creator handle or unique creator identifier</td><td>-</td><td>minimuffin8888</td></tr><tr><td><strong>connector</strong></td><td>Platform source from which insights are fetched</td><td><p>instagram, </p><p>youtube, </p><p>tiktok, </p><p>facebook</p></td><td>instagram</td></tr><tr><td><strong>state</strong></td><td>Unique session state</td><td>-</td><td>-</td></tr></tbody></table>

## Campaign webhook

The webhook payload is sent to notify the client when campaign insights are available.

#### Webhook Payload

<table><thead><tr><th width="154.296875">Field Name</th><th width="166.3046875">Description</th><th width="184.22265625">Possible Values</th><th>Sample Value</th></tr></thead><tbody><tr><td><strong>type</strong></td><td>Identifies the webhook event category</td><td>campaign_insights</td><td>campaign_insights</td></tr><tr><td><strong>campaign_id</strong></td><td>Unique identifier of the campaign</td><td>-</td><td>cmp_102345</td></tr><tr><td><strong>campaign_name</strong></td><td>Name of the campaign</td><td>-</td><td>Summer Launch Campaign</td></tr><tr><td><strong>brand_name</strong></td><td>Brand associated with the campaign</td><td>-</td><td>Nike</td></tr></tbody></table>