Skip to main content
RMZ webhooks send HTTP POST requests to your server whenever specific events occur in your store, such as a new order being created or an order status changing. This lets you build real-time integrations without polling the API.
Webhooks require an RMZ+ subscription plan. You can manage webhooks from your store dashboard.

​
How Webhooks Work

1

Configure a webhook

In your dashboard, create a webhook by specifying the event type, destination URL, and retry settings.
2

Event occurs

When a matching event happens (e.g., a customer places an order), RMZ builds the payload and queues the webhook for delivery.
3

Payload delivered

RMZ sends an HTTP POST request to your URL with the event data as JSON. Custom headers identify the request.
4

Your server responds

Return a 2xx status code to acknowledge receipt. Non-2xx responses trigger retries based on your configuration.

​
Setting Up a Webhook

Navigate to Dashboard > Settings > Webhooks and click Add Webhook.

​
Configuration Fields

FieldRequiredDescription
NameNoA label for your reference (e.g., “Order notifications”)
EventYesThe event type to listen for (e.g., order.created)
URLYesThe HTTPS endpoint that will receive the webhook POST requests
TriesYesNumber of delivery attempts (1 to 5)
EnabledNoToggle the webhook on or off (default: off)
When you create a webhook, a secret key is auto-generated (28 random characters). This key can be used to verify webhook authenticity if you implement signature verification on your end.
Webhook payload signing is not enabled by default. The secret key is generated and stored, but the Signature header is only included when signing is explicitly enabled for the webhook. See Signature Verification for details.
Store your webhook secret key securely. If you suspect it has been compromised, delete the webhook and create a new one.

​
Managing Webhooks

From the webhooks settings page, you can:
  • Create new webhooks with different events and URLs
  • Update the name, event, URL, tries, or enabled status of existing webhooks
  • Delete webhooks you no longer need
  • Toggle webhooks on/off without deleting them

​
Discord Integration

RMZ automatically detects Discord webhook URLs and transforms the payload into a Discord embed format. If your webhook URL contains discord, the payload is converted to a rich embed with order details, customer info, and status — no middleware needed on your end.

​
Request Headers

Every webhook request includes these headers:
HeaderDescription
Content-Typeapplication/json
X-RMZ-WEBHOOKSAPI version (1.2)
X-RMZ-REQUEST-IDUnique request ID for tracking and deduplication
SignatureHMAC-SHA256 signature (only present when signing is enabled for the webhook — not included by default)

Events

See all available webhook event types.

Payload Format

Full payload structure with field descriptions.

Signature Verification

Verify webhook authenticity with HMAC signatures.

Reliability

Retry strategy, timeouts, and delivery guarantees.