Skip to main content
POST
/
telephone-encounters
/
actions
Add Action to Telephone Encounter
curl --request POST \
  --url https://api.usecobalt.com/v1/telephone-encounters/actions \
  --header 'Content-Type: application/json' \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>' \
  --data '
{
  "emr_appointment_id": "<string>",
  "text": "<string>",
  "is_high_priority": "true"
}
'
{
  "success": true,
  "message": "Action processing. A webhook event will be sent upon completion.",
  "action_id": "<string>",
  "job_id": 123
}

Request Parameters

Required Fields

  • emr_appointment_id (string, required): The EMR-specific ID of the telephone encounter
  • text (string, required): The action text/note to add to the telephone encounter log

How It Works

When you add an action to a telephone encounter:
  1. Formatting: The action is automatically formatted with the staff member’s name, timestamp, and timezone
  2. Appending: The formatted action is appended to the existing action log in the telephone encounter
  3. Timestamping: Each action includes the exact date, time, and timezone when it was added

Example Request

curl -X POST https://api.usecobalt.com/v1/telephone-encounters/actions \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-d '{
    "emr_appointment_id": "3784895",
    "text": "Patient called for prescription refill"
}'

Example Response

{
  "success": true,
  "message": "Action processing. A webhook event will be sent upon completion.",
  "action_id": "a7b8c9d0e1f2g3h4i5j6k7l8m9n0o1p2",
  "job_id": 12345
}

Response Fields

  • success (boolean): Indicates if the request was accepted for processing
  • message (string): Confirmation message
  • action_id (string): Unique identifier for the action record (32-character hex string)
  • job_id (integer): Reference to the job that will process this action

Webhook Events

You’ll receive a webhook when the action is processed:

Success Event

{
  "id": "evt_abc123",
  "object": "event",
  "type": "telephone_encounter_action.created",
  "created": "2026-01-21T20:15:30.000Z",
  "job_id": "12345",
  "access_token_reference_id": "user_123",
  "data": {
    "action_id": "a7b8c9d0e1f2g3h4i5j6k7l8m9n0o1p2",
    "emr_appointment_id": "3784895",
    "text": "Patient called for prescription refill"
  }
}

Authorizations

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

Body

application/json
emr_appointment_id
string
required

The EMR-specific ID of the telephone encounter

text
string
required

The action text/note to add to the telephone encounter log

is_high_priority
enum<string>

Whether this action should be marked as high priority (optional). Must be "true" or "false"

Available options:
true,
false

Response

Action queued successfully

success
boolean
message
string
Example:

"Action processing. A webhook event will be sent upon completion."

action_id
string

Unique identifier for the action record (32-character hex string)

job_id
integer

Job execution identifier for tracking the async operation