Webhooks (Management API)

Register webhook subscriptions to receive real-time notifications for events across your organisation. For webhook payload formats and security, see the Webhooks section.

These endpoints require the notification_subscription permissions: notification_subscription:read to list subscriptions, and notification_subscription:write to create, remove, or send a test webhook. A key without the required permission receives 403 Permission Denied. See Permissions for details.

List Webhook Subscriptions

Retrieve all active webhook subscriptions for your organisation.

GET /v1/management/notification-subscriptions

Example Request

curl -X GET "https://api.rxscale.com/v1/management/notification-subscriptions/" \
  -H "X-API-Key: your-api-key-here"

Response

[
  {
    "uid": "ns-abc123",
    "notification_type": "pharmacy_order_created",
    "target": "https://your-system.com/webhooks/rxscale",
    "options": "WEBHOOK",
    "payload_version": "1"
  }
]

Register Webhook Subscription

Create a new webhook subscription for your organisation.

POST /v1/management/notification-subscriptions

Request Body

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

Field	Type	Required	Description
`notification_type`	string	Yes	Event type to subscribe to
`target`	string	Yes	Webhook URL to receive notifications (must be HTTPS and resolve to a public internet address)
`meta_data`	object	No	Optional metadata for the subscription
`payload_version`	string	No	Payload schema version (default: `"1"`)
`header_key`	string	No	Name of a custom header sent with every delivery, for example an API key your endpoint checks. Provide together with `header_value`. Must be a valid HTTP header name: letters, digits, hyphens and underscores (for example `X-Api-Key`), with no spaces or colons. `Content-Type`, `X-Webhook-Event`, `X-Webhook-Signature`, `X-Webhook-Test` and connection-level headers such as `Host`, `Content-Length`, `Transfer-Encoding`, `Connection` and `Proxy-Authorization` are reserved.
`header_value`	string	No	Value of the custom header. Provide together with `header_key`.

Available Event Types

Event Type	Description
`pharmacy_order_created`	A new pharmacy order has been created
`pharmacy_order_updated`	An existing order changed, including status updates and shipments added by the pharmacy
`pharmacy_sku_stock_updated`	Stock level changed for a pharmacy SKU
`patient_doctor_meeting_updated`	A patient-doctor meeting changed lifecycle state

Example Request

curl -X POST "https://api.rxscale.com/v1/management/notification-subscriptions/" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "notification_type": "pharmacy_order_created",
    "target": "https://your-system.com/webhooks/rxscale"
  }'

Response (201 Created)

{
  "uid": "ns-abc123",
  "notification_type": "pharmacy_order_created",
  "target": "https://your-system.com/webhooks/rxscale",
  "options": "WEBHOOK",
  "payload_version": "1",
  "webhook_secret": "Q2hJ5b1mX8r0cN4pZtV7aKdLwE3yUsF9gHjM6nBqRiY"
}

webhook_secret is returned only in this response. Store it securely: you need it to verify the X-Webhook-Signature header of every delivery. See Webhook Security. Each subscription (target URL and event type) has its own webhook_secret. Verify each delivery with the secret of the subscription it belongs to; the X-Webhook-Event header tells you the event type.

Remove Webhook Subscription

Delete (deactivate) a webhook subscription by specifying the target URL and notification type.

DELETE /v1/management/notification-subscriptions

string

required

The webhook target URL

string

required

The notification type to unsubscribe from

Example Request

curl -X DELETE "https://api.rxscale.com/v1/management/notification-subscriptions/?target=https://your-system.com/webhooks/rxscale&notification_type=pharmacy_order_created" \
  -H "X-API-Key: your-api-key-here"

Returns 204 No Content on success.

Test Webhook Delivery

Send a sample webhook payload to a target URL to verify your endpoint is configured correctly. This is useful for verifying your webhook endpoint is working before creating a subscription.

POST /v1/management/notification-subscriptions/test

Request Body

{
  "target_url": "https://your-system.com/webhooks/rxscale",
  "event_type": "pharmacy_order_created",
  "header_key": "X-Custom-Auth",
  "header_value": "my-secret-token"
}

Field	Type	Required	Description
`target_url`	string	Yes	URL to send the test webhook to (must be HTTPS)
`event_type`	string	No	Type of event to simulate (default: `pharmacy_order_created`)
`header_key`	string	No	Custom header name to include in the test request
`header_value`	string	No	Custom header value to include in the test request

Example Request

curl -X POST "https://api.rxscale.com/v1/management/notification-subscriptions/test" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "target_url": "https://your-system.com/webhooks/rxscale",
    "event_type": "pharmacy_order_created",
    "header_key": "X-Custom-Auth",
    "header_value": "my-secret-token"
  }'

Response

{
  "success": true,
  "status_code": 200,
  "payload_sent": {
    "event_type": "pharmacy_order_created",
    "timestamp": 1711700000,
    "payload_version": "1",
    "data": { ... }
  }
}

Test webhook payloads include the header X-Webhook-Test: true so your endpoint can distinguish test deliveries from real ones. If you have an active subscription for target_url and event_type, the test request is also signed with that subscription’s webhook_secret in the X-Webhook-Signature header, exactly like a real delivery. The X-Webhook-Test header is not covered by the signature, so check it before processing a delivery.

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Webhooks

Webhooks (Management API)

List Webhook Subscriptions

Example Request

Response

Register Webhook Subscription

Request Body

Available Event Types

Example Request

Response (201 Created)

Remove Webhook Subscription

Example Request

Test Webhook Delivery

Request Body

Example Request

Response

​Webhooks (Management API)

​List Webhook Subscriptions

​Example Request

​Response

​Register Webhook Subscription

​Request Body

​Available Event Types

​Example Request

​Response (201 Created)

​Remove Webhook Subscription

​Example Request

​Test Webhook Delivery

​Request Body

​Example Request

​Response

Webhooks (Management API)

List Webhook Subscriptions

Example Request

Response

Register Webhook Subscription

Request Body

Available Event Types

Example Request

Response (201 Created)

Remove Webhook Subscription

Example Request

Test Webhook Delivery

Request Body

Example Request

Response