Webhook註冊 webhook
返回 Sofia

Webhook

註冊 webhook

註冊 Sofia 以帶簽章 JSON 事件呼叫的 https URL，失敗最多重試五次。金鑰僅顯示一次，最多 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 地址。解析到私有、迴路或連結本機地址的主機會被拒絕

  • eventsstring[]必填

    要接收的事件

回應

201application/json

webhook 及其簽章金鑰，僅顯示一次。

  • idstring必填

    webhook 的識別碼

  • urlstring必填

    Sofia 呼叫的地址

  • eventsstring[]必填

    已訂閱的事件

  • createdAtstring<date-time>必填

    webhook 的註冊時間

  • secretstring必填

    為每次遞送簽章的 HMAC-SHA256 金鑰（Sofia-Signature）。僅此一次顯示

400

webhook_url_invalid：不是 https，或是私有、迴路或連結本機主機。webhook_event_invalid：未知事件，或沒有事件。

401

權杖缺失、未知、已過期或已被撤銷。

403

權杖沒有 webhooks:write scope。

409

webhook_limit_reached：已有 10 個 webhook。

4XXapplication/json

其他任何錯誤，以錯誤結構回傳。