---
updatedAt: 2026-10-13T21:38:53.000Z
agentTools:
  projectIndex: https://docs.particlehealth.com/llms.txt
---

# Getting Started for Developers

Developer focused guide for how to integrate with Particle and leverage retrieved data.

Particle has two primary integration paths. Choose the one that matches your use case, or combine both once you are up and running.

| Path          | What it does                                                                                             |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| **Workbench** | Register patients, run queries, and retrieve clinical data on demand in FLAT or CCDA format.             |
| **Signal**    | Subscribe patients to continuous monitoring and receive real-time webhook alerts when care events occur. |

Both paths share the same authentication model and patient registration step.

***

## Workbench

### 1. Authenticate

* [Auth & Keys](https://docs.particlehealth.com/docs/auth-and-keys)

### 2. Register Patients

Submit patient demographics to generate a `particle_patient_id`, required for all subsequent calls.

* [Patients API](https://docs.particlehealth.com/docs/patients-api)

### 3. Run a Query

Initiate a query for a registered patient and monitor status until complete.

* [Query & Query Status APIs](https://docs.particlehealth.com/docs/query-and-query-status-apis)
* [Recommended Query Flow](https://docs.particlehealth.com/docs/query-workflow-implementations)

### 4. Retrieve Data

Pull the clinical data returned by your query in FLAT or CCDA format.

* [Data Retrieval APIs](https://docs.particlehealth.com/docs/data-retrieval-apis)

### 5. Set Up Webhooks (optional)

Receive query-complete notifications instead of polling for status.

* [Webhook Event Notifications](https://docs.particlehealth.com/docs/webhook-event-notifications)

***

## Signal

For the full Signal implementation workflow - including patient registration, subscription, webhook configuration, and data retrieval - see the Signal documentation:

### 1. Authenticate

* [Auth & Keys](https://docs.particlehealth.com/docs/auth-and-keys)

### 2. Set Up Signal

Covers patient registration, subscription to monitoring, and webhook configuration.

* [Setting Up Signal](https://docs.particlehealth.com/docs/setting-up-signal)

### 3. Receive and Act on Alerts

* [Transition Alerts](https://docs.particlehealth.com/docs/transition-alerts) - admissions, discharges, transfers
* [Discharge Summary Alerts](https://docs.particlehealth.com/docs/discharge-summaries) - discharge summary availability
* [New Encounter Alerts](https://docs.particlehealth.com/docs/new-encounter-alerts) - new clinical documentation

***

## Additional Resources

* [Particle Connect](https://github.com/ParticleHealth/particle-connect) - our open-source starter repository with a Python SDK, sample workflows, and quickstarts for registering patients, running queries, retrieving data, and setting up Signal webhooks
* [Postman Collection](https://www.postman.com/particlehealth/particle-health-api/collection/49305791-8273f712-b619-4d2c-af76-623afdf7b4af) - pre-configured requests for quick exploration
* [Test Patient Sandbox](https://docs.particlehealth.com/docs/test-patient-sandbox) - explore clinical data formats without production data
* [Life of a Query](https://docs.particlehealth.com/docs/life-of-a-query) - end-to-end walkthrough of the query lifecycle