Webhook Documentation

A webhook is a way for one system to automatically send real-time data to another system when a specific event happens.

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

Field Name	Description	Possible Values	Sample Value
type	Identifies the webhook event or insights category	creator_insights	creator_insights
status	Current processing status of the request	success, failed	success
status_reason	Reason for failure (applicable only when status is failed)	Restricted/Invalid Profile, Private Account, Invalid Handle	Invalid Handle
identifier	Creator handle or unique creator identifier	-	minimuffin8888
connector	Platform source from which insights are fetched	instagram, youtube, tiktok, facebook	instagram

First party creator webhook

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

Webhook Payload

Field Name	Description	Possible Values	Sample Value
type	Identifies the webhook event or insights category	creator_insights_1p	creator_insights_1p
status	Current processing status of the request	success, failed	success
status_reason	Reason for failure (applicable only when status is failed)	Restricted/Invalid Profile, Private Account, Invalid Handle	Invalid Handle
identifier	Creator handle or unique creator identifier	-	minimuffin8888
connector	Platform source from which insights are fetched	instagram, youtube, tiktok, facebook	instagram
state	Unique session state	-	-

Campaign webhook

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

Webhook Payload

Field Name	Description	Possible Values	Sample Value
type	Identifies the webhook event category	campaign_insights	campaign_insights
campaign_id	Unique identifier of the campaign	-	cmp_102345
campaign_name	Name of the campaign	-	Summer Launch Campaign
brand_name	Brand associated with the campaign	-	Nike