RyzeAPI icon

RyzeAPI

Send WhatsApp messages and manage your RyzeAPI instances

Event → Define Websocket

AI-generated

Summary

Configures websocket event delivery for a selected WhatsApp instance, enabling or disabling delivery and optionally choosing event types and whether message events include media base64 data.

Inputs

  • Instance Name or ID (required) — The WhatsApp instance to configure.
  • Enabled (required) — Turns websocket delivery on or off; defaults to false.
  • Events — When enabled, selects event types to deliver: call updates, group flow, instance state, label updates, message exchange, or message status. Defaults to message.exchange; the UI description says an empty selection sends all six.
  • Media Base64 — When enabled, includes media.base64 in message.exchange events. Defaults to false.
  • Request Options — Optional HTTP request settings, including batching, accepting invalid SSL certificates, proxy, and timeout.

Output shape

A single API response item.

The supplied source pack contains only signatures for the operation implementation, so the exact response fields are not shown.

Links

Discussion