Changelog-Eintrag veröffentlicht

Wird ausgelöst, wenn ein Changelog-Eintrag live geht: bei seiner ersten Veröffentlichung oder bei einer Veröffentlichung, nachdem er offline genommen wurde. Das Veröffentlichen von Änderungen an einem bereits live geschalteten Eintrag löst das Ereignis nicht erneut aus. Daher können Sie Ihren Benutzern sicher eine E-Mail senden (prüfen Sie zuerst data.public). Deduplizieren Sie anhand von data.id, wenn Sie pro Eintrag immer nur eine E-Mail senden möchten.

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"
    }
  }
}'

Diese Antwort hat keinen Body.

Zustellung bestätigt; alles andere wird mit Backoff erneut versucht.

Header

· 3

webhook-id string erforderlich

id des Umschlags, eindeutig pro Ereignis.

webhook-timestamp string erforderlich

Unix-Sekunden, zu denen die Anfrage signiert wurde; veraltete Werte ablehnen.

webhook-signature string erforderlich

Durch Leerzeichen getrennte v1,-Tokens — während der Geheimnisrotation mehrere — berechnet wie unter Signaturprüfung beschrieben.

Body

erforderlich application/json

id string erforderlich

Ereigniskennung, die im webhook-id-Header wiederholt wird.

type string · Enum erforderlich

Ereignistyp, der von dieser Zustellung übertragen wird.

Werte

changelog_entry.published

created_at string erforderlich

Zeitpunkt, zu dem das Ereignis erstellt wurde.

data object erforderlich

Der Eintrag, sobald er live ging, mit seinem als HTML und Markdown gerenderten Inhalt, damit Sie ihn ohne einen weiteren API-Aufruf versenden können.

Header

Body

Antworten