Skip to main content

​
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-v1/webhooks/

​
Response

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

​
Register Webhook

POST /v1/external-pharmacy-api-v1/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-v1/webhooks/{subscription_uid}
Returns 204 No Content on success.

​
Available Event Types

Event TypeDescription
pharmacy_order_createdA new pharmacy order has been created
pharmacy_order_updatedAn existing order’s status has changed
pharmacy_sku_stock_updatedStock level changed for one of your SKUs
See Webhook Events for full payload details.