Trigger Sandbox Workflow (v2) [Sandbox only]

post

https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/subscriptions/trigger-sandbox-workflow

Triggers a subscription workflow for a patient in Sandbox, for testing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

particle_patient_id

string

required

Particle Patient ID

Body Params

Subscriptions

callback_url

string

Optional. Only used when neither your project nor its parent organization has a callback endpoint registered for this alert type: the URL is registered on your project and the alert is sent there. Without a registered endpoint or a callback_url, the request returns 400. Otherwise alerts go to the registered endpoints.

display_name

string

Optional. Names the endpoint registered from callback_url. Defaults to "Sandbox ".

event_type

string

Valid Event Type values: A01, A02, A03, A04, A08 (required when workflow is ADT)

workflow

string

Valid Workflow values: ADT, NETWORK_ALERT, TRANSITION_ALERT, MEDICATION_FILLS_ALERT. All other values return 400, including the removed NEW_ENCOUNTER_ALERT, REFERRAL_ALERT, DISCHARGE_SUMMARY_ALERT, ADMIT_TRANSITION_ALERT, DISCHARGE_TRANSITION_ALERT, TRANSFER_TRANSITION_ALERT, and AI_OUTPUTS.

Responses

200OK

400Bad Request

401Unauthorized

404Not Found

406Not Acceptable

500Internal Server Error