Sync Events - Documentation

Sync events fire when Cobalt detects changes that occurred directly in your EHR system. These keep you informed about activities your staff performed in the EHR itself — appointments scheduled, patient information updated, and statuses changed.

appointment.created and appointment.updated also fire as Operation Events when triggered by an RPA action Cobalt performed. The event types are the same; the trigger differs.

Payload Envelope

Every sync event uses this envelope:

{
  "id": "508c368e7de13b40f9397eec966d0329",
  "access_token_reference_id": "your-reference-id",
  "object": "event",
  "created": "2025-07-28T08:50:42.491-07:00",
  "type": "appointment.updated",
  "data": {
    // Event-specific payload
  }
}

Field	Type	Description
`id`	string	Unique identifier for this event
`access_token_reference_id`	string	Your reference ID associated with this webhook
`object`	string	Always `"event"`
`created`	string	ISO 8601 timestamp when the event was created
`type`	string	The event type
`data`	object	Event-specific data payload

Appointment Events

appointment.created

Triggered when EHR staff create an appointment in your EHR (detected by Cobalt’s sync).Payload Example:

{
  "id": "759df7ac-2688-44a9-926c-58d36376b412",
  "access_token_reference_id": "clinic_1",
  "object": "event",
  "created": "2025-07-28T16:05:48.929Z",
  "type": "appointment.created",
  "data": {
    "appointment_id": "c5c0e613fc7d68a1c01ef4160483a0b6",
    "mrn": "44235",
    "date_time": "2025-07-28T16:00:00.000Z",
    "timezone": "America/New_York",
    "provider_id": "defe69ae-f363-4797-87bd-1c70acb52b21",
    "provider_name": "Dr. Jose Gonzalez",
    "secondary_provider_id": null
  }
}

Data Fields:

Field	Type	Description
`appointment_id`	string	Cobalt’s unique identifier for the appointment
`mrn`	string	Patient’s Medical Record Number
`date_time`	string	Appointment date and time (ISO 8601)
`timezone`	string	Timezone for the appointment
`provider_id`	string	Primary provider’s ID
`provider_name`	string	Primary provider’s name
`secondary_provider_id`	string \| null	Secondary provider’s ID (if applicable)

appointment.updated

Triggered when EHR staff update an appointment in your EHR (detected by Cobalt’s sync).Payload Example:

{
  "id": "508c368e7de13b40f9397eec966d0329",
  "access_token_reference_id": "clinic_1",
  "object": "event",
  "created": "2025-07-28T08:50:42.491-07:00",
  "type": "appointment.updated",
  "data": {
    "id": "0551c88b2249945151f967525ee3f7b4",
    "ehr_appointment_id": "482129",
    "patient_mrn": "804",
    "patient_name": "John Doe",
    "datetime": "2025-07-28T16:00:00.000Z",
    "duration": 20,
    "location": "2",
    "status": "2",
    "provider_name": "Dr. Michael Denenberg",
    "appointment_type": "FOLLOW-UP",
    "appointment_mode": "office",
    "updated_fields": {
      "status": "2"
    }
  }
}

Data Fields:

Field	Type	Description
`id`	string	Cobalt’s unique identifier for the appointment
`ehr_appointment_id`	string	The EHR’s native appointment ID
`patient_mrn`	string	Patient’s Medical Record Number
`patient_name`	string	Patient’s full name
`datetime`	string	Appointment date and time (ISO 8601)
`duration`	number	Appointment duration in minutes
`location`	string	Appointment location/room
`status`	string	Appointment status code
`provider_name`	string	Provider’s name
`appointment_type`	string	Type of appointment
`appointment_mode`	string	Mode (e.g., “office”, “telehealth”)
`updated_fields`	object	Fields that changed in this update

appointment.status_updated

Triggered when an appointment’s status changes in your EHR system.Payload Example:

{
  "id": "508c368e7de13b40f9397eec966d0330",
  "access_token_reference_id": "clinic_1",
  "object": "event",
  "created": "2025-07-28T09:15:22.491-07:00",
  "type": "appointment.status_updated",
  "data": {
    "id": "0551c88b2249945151f967525ee3f7b4",
    "ehr_appointment_id": "482129",
    "patient_mrn": "804",
    "patient_name": "John Doe",
    "datetime": "2025-07-28T16:00:00.000Z",
    "status": "checked-in",
    "previous_status": "scheduled",
    "provider_name": "Dr. Michael Denenberg"
  }
}

Data Fields:

Field	Type	Description
`id`	string	Cobalt’s unique identifier for the appointment
`ehr_appointment_id`	string	The EHR’s native appointment ID
`patient_mrn`	string	Patient’s Medical Record Number
`patient_name`	string	Patient’s full name
`datetime`	string	Appointment date and time (ISO 8601)
`status`	string	New appointment status
`previous_status`	string	Previous appointment status
`provider_name`	string	Provider’s name

Patient Events

patient.updated

Triggered when patient information is updated in your EHR system.Payload Example:

{
  "id": "508c368e7de13b40f9397eec966d0331",
  "access_token_reference_id": "clinic_1",
  "object": "event",
  "created": "2025-07-28T10:20:15.491-07:00",
  "type": "patient.updated",
  "data": {
    "mrn": "MRN123456",
    "patient_name": "Jane Smith",
    "updated_fields": {
      "phone": "555-9999",
      "email": "jane.newemail@example.com"
    }
  }
}

Data Fields:

Field	Type	Description
`mrn`	string	Patient’s Medical Record Number
`patient_name`	string	Patient’s full name
`updated_fields`	object	Fields that changed in this update

​Payload Envelope

​Appointment Events

​Patient Events

Payload Envelope

Appointment Events

Patient Events