Skip to content

Realtime

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.

Tool

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

NameTypeRequiredDescription
urlstringEndpoint that receives signed lifecycle POSTs (https in production)
eventsarrayLifecycle event types this webhook receives
descriptionstringFree-form note

Response

FieldTypeAlwaysDescription
secretstringFull signing secret — returned only once, at creation. Store it now.
webhookobject

Try it

Register a client webhook: lifecycle notifications (channel occupied/vacated, presence member added/removed) are POSTed to the URL signed with HMAC-SHA256.

When to use

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.

Example

Ask your agent something like this:

Register a client webhook: lifecycle notifications (channel occupied/vacated, presence member added/removed) are POSTed to the URL signed with HMAC-SHA256.

The agent will invoke realtime_webhook_create with these arguments:

{
  "url": "<url>",
  "events": "<events>"
}

Esc

Start typing to search the docs.

navigateselect