Webhooks

Register webhooks for real-time pharmacy order and stock notifications

Webhooks (External Pharmacy API)

Register webhooks to receive real-time notifications when pharmacy orders are created, updated, or when stock levels change.

List Webhooks

GET /v1/external_pharmacy_api/webhooks/

Response

[
  {
    "uid": "sub-abc123",
    "target": "https://your-system.com/webhooks/rxscale",
    "notification_type": "pharmacy_order_created"
  }
]

Register Webhook

POST /v1/external_pharmacy_api/webhooks/

Request Body

{
  "target": "https://your-system.com/webhooks/rxscale",
  "notification_type": "pharmacy_order_created"
}

Response

{
  "uid": "sub-abc123",
  "target": "https://your-system.com/webhooks/rxscale",
  "notification_type": "pharmacy_order_created",
  "signing_secret": "whsec_abc123..."
}

The signing_secret is only returned once during creation. Store it securely — you’ll need it to verify webhook signatures. See Webhook Security for details.

Remove Webhook

DELETE /v1/external_pharmacy_api/webhooks/{subscription_uid}

Returns 204 No Content on success.

Available Event Types

Event Type	Description
pharmacy_order_created	A new pharmacy order has been created
pharmacy_order_updated	An existing order’s status has changed
pharmacy_sku_stock_updated	Stock level changed for one of your SKUs

See Webhook Events for full payload details.