Changelog entry published

Fires when a changelog entry goes live: its first publish, or a publish after it was taken offline. Publishing edits to an entry that is already live does not fire it again, so it is safe to email your users from (check data.public first). Deduplicate on data.id if you only ever want one email per entry.

POST changelog_entry.published

Bearer token

curl 'https://api.ferndesk.com/v1/changelog_entry.published' \
  --request POST \
  --header 'webhook-id: whevt_01JXYC5R2K9M' \
  --header 'webhook-timestamp: 1752096000' \
  --header 'webhook-signature: v1,K5oT8v...base64...' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "whevt_01JXYC5R2K9M",
  "type": "changelog_entry.published",
  "created_at": "2026-07-09T18:25:43.511Z",
  "data": {
    "id": "art_01JXY9AZK4KV",
    "title": "Faster search",
    "slug": "faster-search",
    "url": "https://docs.example.com/faster-search-A1B2C3",
    "date": "2026-09-30",
    "tags": [
      "new"
    ],
    "announce": true,
    "public": true,
    "content_html": "<p>Search results now load twice as fast.</p>",
    "content_markdown": "Search results now load twice as fast.",
    "published_at": "2026-09-30T14:02:11.000Z",
    "published_by_member_id": "mem_01JXYB8W4Q2H",
    "source": "editor",
    "changelog": {
      "id": "col_01JXYA6ABN52",
      "title": "Changelog",
      "url": "https://docs.example.com/changelog-C0L123"
    }
  }
}'

This response has no body.

Delivery acknowledged; anything else is retried with backoff.

Headers

· 3

webhook-id string required

Envelope id, unique per event.

webhook-timestamp string required

Unix seconds when the request was signed; reject stale values.

webhook-signature string required

Space-separated v1, tokens — several during secret rotation — computed as described under Signature verification.

Body

required application/json

id string required

Event identifier, repeated in the webhook-id header.

type string · enum required

Event type carried by this delivery.

values

changelog_entry.published

created_at string required

When the event was created.

data object required

The entry as it went live, with its body rendered as HTML and Markdown so you can send it on without another API call.

Headers

Body

Responses