realtime_webhook_create
Register a client webhook: lifecycle notifications (channel occupied/vacated, presence member added/removed) are POSTed to the URL signed with HMAC-SHA256.
Register a client webhook: lifecycle notifications (channel occupied/vacated, presence member added/removed) are POSTed to the URL signed with HMAC-SHA256. Returns the full signing secret ONCE.
Behavior
- HTTP
POST /realtime/webhooks
Arguments
Name | Type | Required | Description |
|---|---|---|---|
url | string | • | Endpoint that receives signed lifecycle POSTs (https in production) |
events | array | • | Lifecycle event types this webhook receives |
description | string | — | Free-form note |
Response
Field | Type | Always | Description |
|---|---|---|---|
secret | string | • | Full signing secret — returned only once, at creation. Store it now. |
webhook | object | • |
Try it
Register a client webhook: lifecycle notifications (channel occupied/vacated, presence member added/removed) are POSTed to the URL signed with HMAC-SHA256.