RyzeAPI icon

RyzeAPI

Send WhatsApp messages and manage your RyzeAPI instances

Event → Define Webhook

AI-generated

Summary

Configure a webhook for a selected WhatsApp instance, setting its label and enabled state. When enabled, specify a public HTTPS destination and optionally choose event types, add the event name to each delivery URL, include message media as base64, and set an Authorization header value.

Inputs

  • Instance (required) — WhatsApp instance to configure.
  • Label — Local webhook identifier; defaults to default. The UI description says up to three webhooks per instance and a maximum of 50 characters.
  • Enabled (required) — Whether webhook delivery is enabled. Defaults to false; disabling clears URL, authorization, events, and media settings.
  • URL — Destination URL, required when enabled; the UI specifies public HTTPS.
  • Authorization — Literal value sent in the Authorization header for each delivery.
  • Events — Event types to deliver: call update, group flow, instance state, label update, message exchange, or message status. Defaults to message exchange; the UI says an empty selection sends all six.
  • By Events — Whether to append /<event> to the URL for each delivery; defaults to false.
  • Media Base64 — Whether to include media.base64 in message exchange events; defaults to false.

Output shape

Unclear from the provided source pack.

The operation implementation is not present in the pack; its file contains only a source map comment. The properties declare the webhook configuration fields but do not establish the returned data shape.

Links

Discussion