Skip to main content
POST
Register webhook endpoint

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
url
string
required
Maximum string length: 2048
event_types
enum<string>[]
Maximum array length: 32
Available options:
article.generated,
article.failed,
lead_magnet.ready,
lead_magnet.failed,
ingestion.completed,
ingestion.failed,
social_adaptation.generated,
scout.results_ready,
scout.dispatched,
session.articles_generated,
billing.credits_low,
billing.credits_empty,
agent_worker.published,
agent_worker.competitor_diff_detected,
agent_worker.budget_exhausted,
agent_worker.paused,
agent_worker.run_failed,
agent_worker.approval_requested
description
string
Maximum string length: 300

Response

Webhook endpoint created

webhook_id
string<uuid>
required
url
string
required
secret
string
required
event_types
enum<string>[] | null
required
Available options:
article.generated,
article.failed,
lead_magnet.ready,
lead_magnet.failed,
ingestion.completed,
ingestion.failed,
social_adaptation.generated,
scout.results_ready,
scout.dispatched,
session.articles_generated,
billing.credits_low,
billing.credits_empty,
agent_worker.published,
agent_worker.competitor_diff_detected,
agent_worker.budget_exhausted,
agent_worker.paused,
agent_worker.run_failed,
agent_worker.approval_requested
created_at
string<date-time>
required