v4

Swagger 2.0Proprietary2026-08-0173264.4 KB
Webhooks

Sample event payloads

Returns up to 3 example event payloads for the event type, built from the project's most recent real data (or a static sample when the project has no data). Used by integration editors such as the Zapier sample loader. Requires the Scale plan or above.

get/webhooks/sample/{event_type}

Path parameters

event_type'mention.created' | 'competitor_mention.created' | 'citation.created' | 'prompt_execution.completed' | 'sentiment.negative_detected' | 'recommendation.completed' | 'intelligence_task.completed' required

Query parameters

project_idinteger required

Response

OK

event_typestring
request_idstring