Webhook Events Reference - Parchment Health developer docs

Complete reference of all webhook events sent by Parchment, including payload structures and examples.

Event Structure

All webhooks follow this standard structure:

{
  "event_type": "prescription.created",
  "event_id": "evt_e0a97272f60e4952f4b69f2bfb7acead",
  "timestamp": "2025-12-19T06:15:18.786Z",
  "partner_id": "tacklit",
  "organization_id": "7fa84d2b-26d7-4c71-9b5b-e591eff97e7d",
  "data": {
    "patient_id": "f03b972b-53ea-452d-ae48-024817f6c3b0",
    "partner_patient_id": "1523402100149593750",
    "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae"
    // Event-specific fields
  },
  "metadata": {
    "reserved_1": null,
    "reserved_2": null,
    "reserved_3": null
  }
}

Root Event Fields

Field	Type	Description
`event_type`	string	Event type (e.g., `prescription.created`)
`event_id`	string	Unique event identifier (format: `evt_xxx`)
`timestamp`	string	ISO 8601 timestamp when event was created
`partner_id`	string	Your partner identifier
`organization_id`	string	Parchment organization ID (UUID)
`data`	object	Event-specific data
`metadata`	object	Reserved custom-data fields. Always present; see Reserved Metadata Fields

Data Object (Common Fields)

Field	Type	Description
`patient_id`	string	Parchment patient ID (UUID)
`partner_patient_id`	string	Your internal patient ID
`user_id`	string	ID of the user (prescriber) who triggered the event (UUID)

Reserved Metadata Fields

Every webhook includes a top-level metadata object carrying three reserved fields. They are opaque pass-through values for partner use: you supply them and Parchment echoes them back unchanged on the resulting webhook, so you can correlate an event to your own context (an order id, session, etc.).

Field	Type	Constraints	Description
`reserved_1`	string \| null	≤ 30 chars	Partner pass-through value (echoed from the SSO request). `null` if not supplied.
`reserved_2`	string \| null	≤ 30 chars	Partner pass-through value (echoed from the SSO request). `null` if not supplied.
`reserved_3`	string \| null	≤ 30 chars	Partner pass-through value (echoed from the SSO request). `null` if not supplied.

How they are populated: append reserved_1 / reserved_2 / reserved_3 as query parameters on the redirect_path when generating an SSO token (see Embedded iframe → Reserved parameters). Each field is delivered on the webhook only when present and non-empty; absent fields arrive as null, and values longer than 30 characters are truncated.

Example: SSO request → webhook metadata

A telehealth partner tying a prescription back to their own booking, consultation, and acquisition channel generates the SSO token with those values on the redirect_path:

curl --location 'https://api.sandbox.parchmenthealth.io/external/v1/sso' \
  --header 'x-organization-id: {organization_id}' \
  --header 'x-organization-secret: {organization_secret}' \
  --header 'x-partner-id: {partner_id}' \
  --header 'x-partner-secret: {partner_secret}' \
  --header 'x-user-id: {user_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "redirect_path": "/embed/patients/{patient_id}/prescriptions?reserved_1=BK-2026-4471&reserved_2=consult_88213&reserved_3=app-ios"
  }'

When the clinician completes the action (e.g. creating a prescription), those values are echoed on the webhook metadata so the partner can reconcile the event against their booking system:

{
  "event_type": "prescription.created",
  "event_id": "evt_a2d36605a5ef6325206ee6bbaa38793e",
  "timestamp": "2026-07-05T00:24:13.278Z",
  "partner_id": "demo",
  "organization_id": "8d05a1af-6a6e-44e6-953e-6e1a0bee54ab",
  "data": {
    "patient_id": "57a8378e-2172-45c1-9329-cb800055eb0a",
    "partner_patient_id": "1523402100149593750",
    "user_id": "89be7478-10d1-702e-19d7-0346ac113984",
    "scid": "202VYFQQPM7FTP1Q86"
  },
  "metadata": {
    "reserved_1": "BK-2026-4471",
    "reserved_2": "consult_88213",
    "reserved_3": "app-ios"
  }
}

Prescription Events

prescription.created

Sent when a new prescription is created in Parchment.

{
  "event_type": "prescription.created",
  "event_id": "evt_e0a97272f60e4952f4b69f2bfb7acead",
  "timestamp": "2025-12-19T06:15:18.786Z",
  "partner_id": "tacklit",
  "organization_id": "7fa84d2b-26d7-4c71-9b5b-e591eff97e7d",
  "data": {
    "patient_id": "f03b972b-53ea-452d-ae48-024817f6c3b0",
    "partner_patient_id": "1523402100149593750",
    "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae",
    "scid": "2TM1XVXBJRWXH8NM68"
  },
  "metadata": {
    "reserved_1": null,
    "reserved_2": null,
    "reserved_3": null
  }
}

interface PrescriptionCreatedEvent {
  event_type: 'prescription.created';
  event_id: string;
  timestamp: string; // ISO 8601
  partner_id: string; // Your partner identifier
  organization_id: string; // UUID
  data: {
    patient_id: string; // UUID - Parchment's patient ID
    partner_patient_id: string; // Your system's patient ID
    user_id: string; // UUID - Prescriber's user ID
    scid: string; // Script Control Identifier
  };
  metadata: {
    reserved_1: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_2: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_3: string | null; // Partner pass-through from SSO request (null if not supplied)
  };
}

Root Fields:

Field	Type	Description
`event_type`	string	Always `prescription.created` for this event
`event_id`	string	Unique event identifier (format: `evt_xxx`)
`timestamp`	string	ISO 8601 timestamp when the event was created
`partner_id`	string	Your partner identifier
`organization_id`	string	UUID of the organization where the prescription was created

Data Fields:

Field	Type	Description
`patient_id`	string	Parchment’s internal patient ID (UUID)
`partner_patient_id`	string	Your system’s patient ID (as provided during patient creation)
`user_id`	string	UUID of the user (prescriber) who created the prescription
`scid`	string	Script Control Identifier - the unique identifier for the prescription in the eRx system

When to expect:

After a prescription is successfully created via the Parchment portal or iFrame
Sent immediately after prescription creation is complete

Common use cases:

Update your system with the new prescription SCID
Use the SCID to fetch full prescription details via the Get Patient Prescriptions API endpoint
Sync prescription data to your platform
Trigger follow-up workflows (e.g., patient notifications)

The webhook provides the SCID (Script Control Identifier) which you can use to retrieve the complete prescription details by calling the Get Patient Prescriptions API endpoint with the partner_patient_id.

prescription.ceased

Sent when an active prescription is ceased (stopped) in Parchment.

{
  "event_type": "prescription.ceased",
  "event_id": "evt_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "timestamp": "2025-12-19T06:15:18.786Z",
  "partner_id": "tacklit",
  "organization_id": "7fa84d2b-26d7-4c71-9b5b-e591eff97e7d",
  "data": {
    "patient_id": "f03b972b-53ea-452d-ae48-024817f6c3b0",
    "partner_patient_id": "1523402100149593750",
    "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae",
    "scid": "2TM1XVXBJRWXH8NM68"
  },
  "metadata": {
    "reserved_1": null,
    "reserved_2": null,
    "reserved_3": null
  }
}

interface PrescriptionCeasedEvent {
  event_type: 'prescription.ceased';
  event_id: string;
  timestamp: string; // ISO 8601
  partner_id: string; // Your partner identifier
  organization_id: string; // UUID
  data: {
    patient_id: string; // UUID - Parchment's patient ID
    partner_patient_id: string; // Your system's patient ID
    user_id: string; // UUID - Prescriber's user ID
    scid: string; // Script Control Identifier
  };
  metadata: {
    reserved_1: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_2: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_3: string | null; // Partner pass-through from SSO request (null if not supplied)
  };
}

Root Fields:

Field	Type	Description
`event_type`	string	Always `prescription.ceased` for this event
`event_id`	string	Unique event identifier (format: `evt_xxx`)
`timestamp`	string	ISO 8601 timestamp when the event was created
`partner_id`	string	Your partner identifier
`organization_id`	string	UUID of the organization where the prescription was ceased

Data Fields:

Field	Type	Description
`patient_id`	string	Parchment’s internal patient ID (UUID)
`partner_patient_id`	string	Your system’s patient ID (as provided during patient creation)
`user_id`	string	UUID of the user (prescriber) who ceased the prescription
`scid`	string	Script Control Identifier - the unique identifier for the prescription in the eRx system

When to expect:

After an active prescription is ceased via the Parchment portal or iFrame
Sent immediately after the cease action is complete

Common use cases:

Mark the prescription as no longer active in your system
Stop any follow-up workflows tied to the ceased prescription
Use the SCID to fetch the latest prescription state via the Get Patient Prescriptions API endpoint

prescription.cancelled

Sent when a prescription is cancelled in Parchment.

{
  "event_type": "prescription.cancelled",
  "event_id": "evt_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "timestamp": "2025-12-19T06:15:18.786Z",
  "partner_id": "tacklit",
  "organization_id": "7fa84d2b-26d7-4c71-9b5b-e591eff97e7d",
  "data": {
    "patient_id": "f03b972b-53ea-452d-ae48-024817f6c3b0",
    "partner_patient_id": "1523402100149593750",
    "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae",
    "scid": "2TM1XVXBJRWXH8NM68"
  },
  "metadata": {
    "reserved_1": null,
    "reserved_2": null,
    "reserved_3": null
  }
}

interface PrescriptionCancelledEvent {
  event_type: 'prescription.cancelled';
  event_id: string;
  timestamp: string; // ISO 8601
  partner_id: string; // Your partner identifier
  organization_id: string; // UUID
  data: {
    patient_id: string; // UUID - Parchment's patient ID
    partner_patient_id: string; // Your system's patient ID
    user_id: string; // UUID - Prescriber's user ID
    scid: string; // Script Control Identifier
  };
  metadata: {
    reserved_1: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_2: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_3: string | null; // Partner pass-through from SSO request (null if not supplied)
  };
}

Root Fields:

Field	Type	Description
`event_type`	string	Always `prescription.cancelled` for this event
`event_id`	string	Unique event identifier (format: `evt_xxx`)
`timestamp`	string	ISO 8601 timestamp when the event was created
`partner_id`	string	Your partner identifier
`organization_id`	string	UUID of the organization where the prescription was cancelled

Data Fields:

Field	Type	Description
`patient_id`	string	Parchment’s internal patient ID (UUID)
`partner_patient_id`	string	Your system’s patient ID (as provided during patient creation)
`user_id`	string	UUID of the user (prescriber) who cancelled the prescription
`scid`	string	Script Control Identifier - the unique identifier for the prescription in the eRx system

When to expect:

After a prescription is cancelled via the Parchment portal or iFrame
Sent immediately after the cancel action is complete

Common use cases:

Mark the prescription as cancelled in your system
Reverse or void any workflow tied to the cancelled prescription
Use the SCID to fetch the latest prescription state via the Get Patient Prescriptions API endpoint

prescription.reissued

Sent when a prescription is reissued in Parchment (the prescription token is re-delivered; the SCID is unchanged).

{
  "event_type": "prescription.reissued",
  "event_id": "evt_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
  "timestamp": "2025-12-19T06:15:18.786Z",
  "partner_id": "tacklit",
  "organization_id": "7fa84d2b-26d7-4c71-9b5b-e591eff97e7d",
  "data": {
    "patient_id": "f03b972b-53ea-452d-ae48-024817f6c3b0",
    "partner_patient_id": "1523402100149593750",
    "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae",
    "scid": "2TM1XVXBJRWXH8NM68"
  },
  "metadata": {
    "reserved_1": null,
    "reserved_2": null,
    "reserved_3": null
  }
}

interface PrescriptionReissuedEvent {
  event_type: 'prescription.reissued';
  event_id: string;
  timestamp: string; // ISO 8601
  partner_id: string; // Your partner identifier
  organization_id: string; // UUID
  data: {
    patient_id: string; // UUID - Parchment's patient ID
    partner_patient_id: string; // Your system's patient ID
    user_id: string; // UUID - Prescriber's user ID
    scid: string; // Script Control Identifier (unchanged by reissue)
  };
  metadata: {
    reserved_1: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_2: string | null; // Partner pass-through from SSO request (null if not supplied)
    reserved_3: string | null; // Partner pass-through from SSO request (null if not supplied)
  };
}

Root Fields:

Field	Type	Description
`event_type`	string	Always `prescription.reissued` for this event
`event_id`	string	Unique event identifier (format: `evt_xxx`)
`timestamp`	string	ISO 8601 timestamp when the event was created
`partner_id`	string	Your partner identifier
`organization_id`	string	UUID of the organization where the prescription was reissued

Data Fields:

Field	Type	Description
`patient_id`	string	Parchment’s internal patient ID (UUID)
`partner_patient_id`	string	Your system’s patient ID (as provided during patient creation)
`user_id`	string	UUID of the user (prescriber) who reissued the prescription
`scid`	string	Script Control Identifier - unchanged by the reissue (the same prescription is re-delivered)

When to expect:

After a prescription token is reissued via the Parchment portal or iFrame
Sent immediately after the reissue action is complete

Common use cases:

Notify the patient that the prescription token has been re-sent
Refresh any cached prescription token / delivery details in your system
Use the SCID to fetch the latest prescription state via the Get Patient Prescriptions API endpoint

The fetched prescription includes a delivery object describing how and where it was sent (channel, recipient type, destination, and the pharmacy identity for pharmacy sends). delivery always reflects the current version, so a reissue overwrites it. To build a full delivery history (e.g. an original send followed by reissues to different addresses), fetch the prescription in response to each prescription.created / prescription.reissued notification — every fetch returns the delivery state as at that event. The webhook payload itself carries IDs only.

Event Filtering

By Event Type

Process only specific event types:

app.post('/webhook', (req, res) => {
  const event = req.body;

  switch (event.event_type) {
    case 'prescription.created':
      handlePrescriptionCreated(event);
      break;

    case 'prescription.ceased':
      handlePrescriptionCeased(event);
      break;

    case 'prescription.cancelled':
      handlePrescriptionCancelled(event);
      break;

    case 'prescription.reissued':
      handlePrescriptionReissued(event);
      break;

    // Handle other events...
  }

  res.status(200).json({ received: true });
});

​Event Structure

​Root Event Fields

​Data Object (Common Fields)

​Reserved Metadata Fields

​Example: SSO request → webhook metadata

​Prescription Events

​prescription.created

​prescription.ceased

​prescription.cancelled

​prescription.reissued

​Event Filtering

​By Event Type

Event Structure

Root Event Fields

Data Object (Common Fields)

Reserved Metadata Fields

Example: SSO request → webhook metadata

Prescription Events

prescription.created

prescription.ceased

prescription.cancelled

prescription.reissued

Event Filtering

By Event Type