WebhooksEinen Webhook registrieren
Zurück zu Sofia

Webhooks

Einen Webhook registrieren

Registriert eine https-URL, die Sofia mit einem signierten JSON-Ereignis aufruft, bei Fehlern bis zu fünfmal wiederholt. Secret einmal sichtbar; max. 10.

POSThttps://api.sofia-post.com/api/v1/webhooks
POST/v1/webhooks

Diese Anfrage wirkt auf Ihr echtes Konto.

curl -X POST 'https://api.sofia-post.com/api/v1/webhooks' \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://crm.example.com/hooks/sofia","events":["post.published"]}'

Autorisierungen

  • Authorizationstringerforderlich

    Ihr persönlicher Schlüssel oder OAuth-Access-Token, gesendet als Bearer <token>.

Body

application/json

  • urlstringerforderlich

    Die https-Adresse, die Sofia aufruft. Ein Host, der auf eine private, Loopback- oder Link-Local-Adresse auflöst, wird abgelehnt

  • eventsstring[]erforderlich

    Die zu empfangenden Ereignisse

Antwort

201application/json

Der Webhook und sein Signatur-Secret, nur einmal angezeigt.

  • idstringerforderlich

    Kennung des Webhooks.

  • urlstringerforderlich

    Von Sofia aufgerufene Adresse

  • eventsstring[]erforderlich

    Die abonnierten Ereignisse

  • createdAtstring<date-time>erforderlich

    Wann der Webhook registriert wurde

  • secretstringerforderlich

    Der HMAC-SHA256-Schlüssel, der jede Zustellung signiert (Sofia-Signature). Nur dieses eine Mal angezeigt

400

webhook_url_invalid: nicht https oder ein privater, Loopback- oder Link-Local-Host. webhook_event_invalid: unbekanntes oder fehlendes Ereignis.

401

Das Token fehlt, ist unbekannt, abgelaufen oder widerrufen.

403

Dem Token fehlt die Berechtigung webhooks:write.

409

webhook_limit_reached: bereits 10 Webhooks.

4XXapplication/json

Jeder andere Fehler, im Fehlerumschlag.