Webhookwebhook を登録する
Sofia に戻る

Webhook

webhook を登録する

Sofia が署名付き JSON で呼び出す https URL を登録します。最大 5 回再試行。シークレットは 1 回のみ表示、最大 10 件。

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

このリクエストは、実際のアカウントに対して実行されます。

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

認可

  • Authorizationstring必須

    個人キーまたは OAuth アクセストークン。Bearer <token> として送信します。

ボディ

application/json

  • urlstring必須

    Sofia が呼び出す https の URL。プライベート、ループバック、リンクローカルのアドレスに解決されるホストは拒否されます

  • eventsstring[]必須

    受信するイベント

レスポンス

201application/json

webhook と署名シークレット。シークレットは 1 回だけ表示されます。

  • idstring必須

    webhook の ID

  • urlstring必須

    Sofia が呼び出す URL

  • eventsstring[]必須

    購読中のイベント

  • createdAtstring<date-time>必須

    webhook が登録された日時

  • secretstring必須

    各配信に署名する HMAC-SHA256 キー（Sofia-Signature）。表示されるのはこの 1 回だけです

400

webhook_url_invalid：https ではない、またはプライベート、ループバック、リンクローカルのホスト。webhook_event_invalid：未知のイベント、またはイベントなし。

401

トークンがない、不明、期限切れ、または失効しています。

403

トークンに webhooks:write スコープがありません。

409

webhook_limit_reached：すでに 10 件あります。

4XXapplication/json

その他のエラー。エラーエンベロープで返されます。