Skip to main content
GET
/
calendar
/
event
/
messages
/
{event_id}
Get Event Messages
curl --request GET \
  --url https://api.decodahealth.com/calendar/event/messages/{event_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "chatId": "<string>",
    "status": "CREATED",
    "sender": {
      "id": "<string>",
      "type": "PROVIDER",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>"
    },
    "createdDate": "2023-11-07T05:31:56Z",
    "messageUid": "<string>",
    "content": "<string>",
    "errorMessage": "<string>",
    "sendoMessageId": "<string>",
    "functionCall": {},
    "files": [],
    "suggestedMessages": [
      {
        "id": "<string>",
        "chatId": "<string>",
        "fromMessageId": "<string>",
        "content": "<string>",
        "assistantId": "<string>",
        "isSelected": true,
        "createdDate": "2023-11-07T05:31:56Z"
      }
    ],
    "toolCalls": [
      {
        "id": "<string>",
        "toolName": "<string>",
        "toolArguments": {},
        "createdDate": "2023-11-07T05:31:56Z",
        "callId": "<string>",
        "messageId": "<string>",
        "alertId": "<string>",
        "toolCallId": "<string>",
        "result": {},
        "toolCallDescription": "<string>",
        "hasBeenCalled": false
      }
    ],
    "eventId": "<string>",
    "type": "REMINDER"
  }
]

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

event_id
string
required

Response

Successful Response

id
string
required
chatId
string
required
status
enum<string>
required
Available options:
CREATED,
QUEUED,
SCHEDULED,
SENDING,
SENT,
UNDELIVERED,
DELIVERED,
READ,
FAILED,
EXPIRED,
OPTED_OUT
sender
UserTiny · object
required
createdDate
string<date-time>
required
messageUid
string | null
content
string | null
errorMessage
string | null
sendoMessageId
string | null
functionCall
Functioncall · object
files
string[] | null
suggestedMessages
SuggestedMessageSummary · object[] | null
toolCalls
ToolCallSummary · object[] | null
eventId
string | null
type
enum<string> | null
Available options:
REMINDER,
OVERRIDE,
FOLLOW_UP,
EXPIRED,
CONFIRMATION,
INTRODUCTORY,
CANCELLED,
UPDATE