Skip to main content
POST
/
api
/
agent
/
webhooks
Register webhook endpoint
curl --request POST \
  --url https://www.citedy.com/api/agent/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "event_types": [
    "article.generated"
  ],
  "description": "<string>"
}
'
{
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "secret": "<string>",
  "event_types": [
    "article.generated"
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://www.citedy.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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
​
created_at
string<date-time>
required