WebhookDaftarkan webhook
Kembali ke Sofia

Webhook

Daftarkan webhook

Mendaftarkan URL https yang dipanggil Sofia dengan event JSON bertanda tangan, diulang hingga lima kali bila gagal. Secret tampil sekali; maksimal 10 webhook.

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

Permintaan ini bertindak pada akun asli Anda.

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

Otorisasi

  • Authorizationstringwajib

    Kunci pribadi atau access token OAuth Anda, dikirim sebagai Bearer <token>.

Body

application/json

  • urlstringwajib

    Alamat https yang dipanggil Sofia. Host yang beresolusi ke alamat privat, loopback, atau link-local ditolak

  • eventsstring[]wajib

    Event yang akan diterima

Respons

201application/json

Webhook beserta signing secret-nya, hanya ditampilkan sekali.

  • idstringwajib

    Pengenal webhook

  • urlstringwajib

    Alamat yang dipanggil Sofia

  • eventsstring[]wajib

    Event yang disubscribe

  • createdAtstring<date-time>wajib

    Kapan webhook didaftarkan

  • secretstringwajib

    Kunci HMAC-SHA256 yang menandatangani setiap pengiriman (Sofia-Signature). Hanya ditampilkan sekali ini

400

webhook_url_invalid: bukan https, atau host privat, loopback, atau link-local. webhook_event_invalid: event tidak dikenal, atau tidak ada.

401

Token tidak ada, tidak dikenal, kedaluwarsa, atau dicabut.

403

Token tidak memiliki scope webhooks:write.

409

webhook_limit_reached: sudah ada 10 webhook.

4XXapplication/json

Kesalahan lain apa pun, dalam amplop kesalahan.