Skip to main content

​
Webhooks

Webhooks let you receive real-time HTTP notifications when events happen in RxScale. Instead of polling for changes, register a webhook URL and RxScale will send you a POST request whenever an event occurs.

​
How Webhooks Work

  1. Register a webhook subscription with your target URL and desired event type.
  2. Receive POST requests to your URL when events occur.
  3. Verify the webhook signature to ensure the request is authentic.
  4. Respond with a 2xx status code to acknowledge receipt.

​
Webhook Payload Format

All webhook payloads follow the same envelope structure: 
{
  "event_type": "pharmacy_order_created",
  "timestamp": 1711700000,
  "payload_version": "1",
  "data": {
    // Event-specific data
  }
}
FieldTypeDescription
event_typestringThe type of event that occurred
timestampintegerUnix timestamp of when the event was generated
payload_versionstringSchema version of the payload (currently "1")
dataobjectEvent-specific data — see Events for details

​
Registering Webhooks

You can register webhooks through:
  • External Pharmacy API — POST /v1/external-pharmacy-api-v1/webhooks/
  • Management API — POST /v1/management/notification-subscriptions/
Each registration returns a signing_secret that you must store securely for payload verification.

​
Retry Policy

If your endpoint does not respond with a 2xx status code, RxScale will retry the delivery with exponential backoff.