Message data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
channels | MessagingReference[] | No | Represents all channels to which the message is sent. Identifies the channels where the message is posted. To send to the "Draft" channel/folder, use a channel ID "DRAFT". |
channels[].id | string | No | |
channels[].name | string | No | |
parent_id | string | No | Represents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies. |
message_thread_identifier | string | No | the opaque identifier for the first message in a thread |
author_member | object | No | for email systems, this field represents the From value |
author_member.user_id | string | No | (reference to HrisEmployee) |
author_member.email | string | No | |
author_member.name | string | No | |
author_member.image_url | string | No | |
destination_members | MessagingMember[] | No | for email systems, this field represents the To value |
destination_members[].user_id | string | No | (reference to HrisEmployee) |
destination_members[].email | string | No | |
destination_members[].name | string | No | |
destination_members[].image_url | string | No | |
hidden_members | MessagingMember[] | No | for email systems, this field represents the BCC value |
hidden_members[].user_id | string | No | (reference to HrisEmployee) |
hidden_members[].email | string | No | |
hidden_members[].name | string | No | |
hidden_members[].image_url | string | No | |
mentioned_members | MessagingMember[] | No | for email systems, this field represents the CC value |
mentioned_members[].user_id | string | No | (reference to HrisEmployee) |
mentioned_members[].email | string | No | |
mentioned_members[].name | string | No | |
mentioned_members[].image_url | string | No | |
reactions | MessagingReaction[] | No | |
reactions[].reaction | string | Yes | |
reactions[].member | MessagingReaction_member | Yes | |
reactions[].member.user_id | string | No | (reference to HrisEmployee) |
reactions[].member.email | string | No | |
reactions[].member.name | string | No | |
reactions[].member.image_url | string | No | |
subject | string | No | |
message | string | No | The message body as plain text |
message_html | string | No | |
message_markdown | string | No | |
attachments | MessagingAttachment[] | No | |
attachments[].filename | string | No | |
attachments[].size | number | No | |
attachments[].content_identifier | string | No | the inline attachment's content_id |
attachments[].content_type | string | No | |
attachments[].download_url | string | No | |
attachments[].message_id | string | No | |
web_url | string | No | |
reference | string | No | eg. RFC822 MessageID |
has_children | boolean | No | |
is_unread | boolean | No | |
buttons | MessagingButton[] | No | |
buttons[].id | string | Yes | |
buttons[].text | string | No | |
buttons[].icon | string | No | |
metadata | MessagingMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?