Sync Forms
Forms
Sync Forms
Queues a sync of the connected EMR’s form definitions into the Cobalt cache.
POST
Sync Forms
Queues a background sync that scrapes the connected EMR’s form definitions and upserts them into the Cobalt cache. The request returns immediately with
Returned with
This indicates an issue with your access token.
202 Accepted; a forms.synced webhook is sent when the sync completes. The cached results are then served by GET /v1/forms and GET /v1/forms/{id}.
A daily scheduler drives the routine cadence — use this endpoint for on-demand or onboarding refreshes.
Forms are currently supported for Credible.
Concurrency
Only one sync may run per account at a time. If a sync is already in progress, the request returns409 with the id of the in-flight job so you can back off rather than queueing a duplicate.
Request Parameters
Optional Fields
- callback_urls (array of strings, optional): URLs to receive the
forms.syncedwebhook, in addition to your account webhook.
Example Request
Example Response
Error Responses
Sync Already Running
409. Wait for the in-flight sync (identified by job_execution_id) to finish before retrying.
Unsupported EMR
User Not Found
Webhook Notification
When the sync finishes, we send aforms.synced webhook to your registered endpoint. Read the refreshed forms with GET /v1/forms.Authorizations
Body
application/json
URLs to receive the forms.synced webhook, in addition to the account webhook.