Sign in

v4

Swagger 2.0Proprietary2026-08-0173264.4 KB
Webhooks

Create a webhook subscription

Subscribes a public HTTPS URL to a project event. LLM Pulse POSTs a JSON envelope (event, occurred_at, project_id, subscription_id, data) to the URL every time the event occurs, signed via the X-LLMPulse-Signature header (HMAC-SHA256 of the raw body computed with the subscription secret). Failed deliveries are retried 5 times with backoff; subscriptions auto-disable after 20 consecutive failed deliveries. Idempotent for the same project + event + URL. Requires a read_write scope API key and the Scale plan or above.

post/webhooks

Request body

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

Public HTTPS URL that will receive signed event payloads

Response

Created. The signing secret is only returned by this endpoint.

idinteger
project_idinteger
event_type'mention.created' | 'competitor_mention.created' | 'citation.created' | 'prompt_execution.completed' | 'sentiment.negative_detected' | 'recommendation.completed' | 'intelligence_task.completed'
target_urlstring
disabledboolean
failure_countinteger
last_delivered_atstring date-time
created_atstring date-time
secretstring

HMAC signing secret (whsec_...). Only returned on create.