OpenWA icon

OpenWA

Interact with OpenWA WhatsApp API Gateway

Actions138

Webhook → Create

AI-generated

Summary

Register a webhook URL for a session and subscribe it to selected OpenWA events. Optionally filter message events, add delivery headers and retries, and sign deliveries with a shared secret.

Inputs

  • Session Name or ID (required) — Select the session whose events to receive.
  • Webhook URL (required) — Destination for webhook deliveries. URLs containing embedded credentials are refused; when gateway SSRF protection is enabled, private or loopback addresses are also refused.
  • Events — Events to subscribe to; defaults to Message Received. Options include message, group, session, call, presence, and status events. Some events are engine- or server-version-dependent as noted in the option descriptions.
  • Additional Fields: Filters — JSON message-event filters. Conditions are ANDed; they do not filter session, group, or call events. Some event types lack fields such as sender, so matching those fields can suppress those events.
  • Additional Fields: Headers — JSON object of extra headers sent with each delivery; gateway-reserved headers cannot be overridden.
  • Additional Fields: Retry Count — Total delivery attempts per event, including the first, from 0 to 5. Values 0 and 1 both result in a single attempt.
  • Webhook Secret — Shared secret of 16–255 characters. When set, deliveries include an X-OpenWA-Signature HMAC-SHA256 header.

Output shape

A single record describing the created webhook registration.

The operation sends a registration request to the OpenWA gateway; the returned record shape is determined by the gateway response.

Links

Discussion