Cicadence API Documentation & Data Integration GuideThe most common question we get from prospects is "how does Cicadence actually pull queue volume out of CareTend, PioneerRx, Epic, Cerner, or our existing system?" There are four practical patterns. Pick the one that matches your stack and timeline; you can always upgrade later. Cicadence only needs aggregate counts per work queue — no PHI ever has to leave your environment for the queue use case.Getting your data into CicadencePattern 1: Vendor's official partner / API programClean and slow. Sign a data-sharing agreement with the source vendor (e.g. WellSky for CareTend, Epic via App Orchard / FHIR sandbox), get issued credentials, and run a small poller that calls a few endpoints every few minutes. Each response converts into a call to PUT /api/v1/queues/:id/volume. Typical effort 4–12 weeks, mostly contracting. Best long-term path.Pattern 2: Scheduled report drop (CSV / SFTP / email)Fast and low-tech. Your existing reporting tool — Crystal, SSRS, the EHR's built-in scheduler, Power BI subscriptions — exports a per-queue-count CSV every 5–15 minutes to SFTP, a watched mailbox, or a network share. Cicadence watches the destination and updates the queues. No vendor contract needed; pharmacy IT controls the scheduler. Most pharmacies start here. Works against CareTend, PioneerRx, Liberty, Computer-Rx, Enterprise Rx, McKesson EnterpriseRx, and most EHR reporting layers.Pattern 3: Push from a small middleware scriptBest balance for customers who already have a data warehouse, Power BI gateway, Looker model, or any internal tooling that touches the source system. A short script (Python, Node, .NET — anything that runs on your network) counts rows per work queue every few minutes and POSTs to the Cicadence REST API. Live in days. Works equally well against Epic, Cerner / Oracle Health, Meditech, Athena, and NextGen via your warehouse.Pattern 4: Manual entryA lead pharmacist or charge nurse updates queue counts in the Cicadence UI a few times per shift. Real and useful — the right starting point when the goal is to prove the staffing math before plumbing data. Day-one capability, no integration work.CareTend, PioneerRx, Epic, Cerner, and the other systems named above are integration targets and examples — naming them does not imply a signed partnership with Cicadence. See the integration status matrix on /partners for what is Available, Beta, and Roadmap today.Integration status at a glance

Available — public REST API, inbound and outbound webhooks, real-time WebSocket updates, middleware script push (pattern 3), manual entry (pattern 4), OIDC login

Beta — scheduled report drop (pattern 2): CSV / SFTP / mailbox watcher, configured with each customer during onboarding

Roadmap — named vendor connectors (CareTend, PioneerRx, Epic, Cerner, Salesforce, HRIS platforms) and SAML / enterprise SSO; these systems feed Cicadence today via the CSV/API patterns above

Where the data landsPatterns 1–3 all converge on the same two endpoints. PUT /api/v1/queues/:id/volume is the primary path for queue counts and triggers a real-time WebSocket update. POST /api/v1/webhooks/incoming is the optional path for status, shift, and assignment events from external systems.Public REST APIThe Cicadence public REST API lets you manage queues, employees, schedules, time tracking, and reports programmatically. Authentication uses bearer tokens with per-key rate limiting. Real-time queue volume changes are broadcast via WebSocket.

Bearer-token authentication with per-key rate limits

Real-time WebSocket updates for queue volume and staffing changes

Webhooks for outbound automation and incoming events

Endpoints for queues, employees, schedules, time tracking, and reports

Generate API keys from the Settings > API Access page in your Cicadence account.