Webhook uç noktası oluştur


POST https://app.apsilo.com/api/public/v1/webhooks

Yanıttaki secret yalnızca bir kez gösterilir; imza doğrulaması için saklayın. Firma başına en çok 20 uç nokta.

Gerekli kapsam: webhooks:manage

Parametreler

Parametre	Yer	Tip	Gereklilik	Açıklama
`Idempotency-Key`	başlık	string	isteğe bağlı	İsteğe özgü benzersiz değer (1–255 yazdırılabilir ASCII; ör. UUID). Aynı anahtar + aynı yol ve gövde 24 saat içinde kaydedilmiş yanıtı döner (`Idempotent-Replayed: true`); farklı gövde veya işlenmekte olan istek `409 IDEMPOTENCY_CONFLICT`. Hata yanıtları saklanmaz.
`X-Request-Id`	başlık	string	isteğe bağlı	İsteğe bağlı istek kimliğiniz (8–100 karakter: harf, rakam, `._:-`); yanıtta aynen döner ve kayıtlara işlenir.

İstek gövdesi

Alan	Tip	Gereklilik	Açıklama
`url`	string (uri)	zorunlu	Olayların POST edileceği adres (canlıda https; özel/yerel IP ve 80/443 dışı port yasak)
`description`	string \| null	isteğe bağlı
`events`	`message.received` · `message.sent` · `message.delivered` · `message.read` · `message.failed` · `conversation.assigned` · `conversation.closed` · `comment.received` · `message.analyzed` · `contact.created` · `contact.updated` · `contact.opted_out` · `contact.deleted` · `campaign.started` · `campaign.completed` · `survey.response` · `record.created` · `record.stage_changed` · `call.completed` · `call.missed` · `template.status_changed` · `social.post.published` · `social.post.failed`[]	zorunlu	Abone olunan olay türleri
`active`	boolean	isteğe bağlı	Etkin mi Varsayılan: `true`.


{
  "url": "https://erp.demokahve.com/apsilo/webhook",
  "description": "ERP mesaj durumları",
  "events": [
    "message.received",
    "message.delivered",
    "message.failed"
  ]
}

Yanıtlar

Durum	Açıklama
`201`	Uç nokta oluşturuldu
`401`	Kimlik doğrulanamadı. Olası kodlar: `API_KEY_INVALID`, `API_KEY_REVOKED`, `API_KEY_EXPIRED`.
`403`	Erişim reddedildi. Olası kodlar: `FEATURE_NOT_LICENSED`, `API_SCOPE_MISSING`, `IP_NOT_ALLOWED`, `LICENSE_EXPIRED`, `LICENSE_NOT_FOUND`, `FORBIDDEN`.
`409`	Çakışma. Olası kodlar: `CONFLICT`, `IDEMPOTENCY_CONFLICT`, `MEDIA_IN_USE`, `SOCIAL_APPROVAL_REQUIRED`, `SOCIAL_POST_NOT_EDITABLE`.
`422`	İşlenemeyen istek. Olası kodlar: `VALIDATION_FAILED`, `MESSAGING_WINDOW_CLOSED`, `CHANNEL_ACCOUNT_MISSING`, `CONTACT_BLOCKED`, `STORAGE_LIMIT_REACHED`, `SOCIAL_POST_INVALID`, `SOCIAL_PLATFORM_UNAVAILABLE`.
`429`	Hız sınırı aşıldı. Olası kodlar: `RATE_LIMITED`.
`500`	Sunucu hatası. Olası kodlar: `INTERNAL`.

Yanıt gövdesi

Alan	Tip	Gereklilik	Açıklama
`data`	WebhookEndpointWithSecret	zorunlu