Fetch Org Settings
Org Settings
Fetch Org Settings
Queues a live sync of your organization’s settings from the connected EMR system.
POST
Fetch Org Settings
This is an asynchronous operation. It returns immediately with a
job_execution_id and delivers an org_settings.synced webhook when the sync
finishes. To read the synced values, use the corresponding read endpoints such as
Get Providers,
Get Locations,
Get Visit Types,
Get Visit Statuses, and
Get Settings.What Gets Synced
A single sync refreshes the full set of organization settings from the EMR:- Providers
- Locations
- Visit types
- Visit statuses
- Insurance companies
- Pharmacies
- Referring providers
- Timezone
- Required patient fields
Concurrency
Only one org settings sync can be in flight per linked account at a time. If a sync is already running when you call this endpoint, the request returns409 with the
job_execution_id of the in-flight sync so you can wait for it to finish rather
than queuing a duplicate.
Example Request
Routing the completion webhook
The completion webhook is delivered to your account’s registered webhook URLs by default. To route this specific sync’sorg_settings.synced event elsewhere,
include a callback_urls array (see Webhook setup). Each
URL must use HTTPS.
Example Response
Webhook Notification
When the sync completes, Cobalt sends anorg_settings.synced webhook to your
registered endpoint (or to callback_urls if you supplied them). The payload is
intentionally minimal — it signals completion and reports counts of what changed.
Re-fetch the synced values from the read endpoints listed above.
You must be subscribed to the
org_settings.synced event for the webhook to be
delivered. See Webhook setup to manage your
subscriptions.Authorizations
Body
application/json
Optional. One or more HTTPS URLs to receive the org_settings.synced completion webhook for this request instead of your account's registered webhook URLs. Accepts a single string or an array of strings. Each URL must use HTTPS.