Skip to main content
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 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 returns 409 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.synced webhook, in addition to your account webhook.

Example Request

Example Response

Error Responses

Sync Already Running

Returned with 409. Wait for the in-flight sync (identified by job_execution_id) to finish before retrying.

Unsupported EMR

User Not Found

This indicates an issue with your access token.

Webhook Notification

When the sync finishes, we send a forms.synced webhook to your registered endpoint. Read the refreshed forms with GET /v1/forms.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Body

application/json
callback_urls
string[]

URLs to receive the forms.synced webhook, in addition to the account webhook.

Response

Forms sync queued; results delivered by webhook

success
boolean
status
string
Example:

"queued"

message
string
Example:

"Forms sync started. A forms.synced webhook will be sent when it completes."

job_execution_id
string

Job execution identifier for the queued sync.