Event data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | not used |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
type | enum | No | Values: MESSAGE_RECEIVED, REACTION_ADDED, REACTION_REMOVED, BUTTON_CLICK, APP_MENTION, CHANNEL_JOINED, CHANNEL_LEFT, CHANNEL_CREATED, CHANNEL_DELETED, CHANNEL_RENAMED, USER_CREATED, USER_DELETED, USER_UPDATED |
channel | object | No | |
channel.id | string | No | |
channel.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
channel.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
channel.name | string | No | |
channel.description | string | No | |
channel.parent_id | string | No | |
channel.has_subchannels | boolean | No | |
channel.members | MessagingMember[] | No | |
channel.members[].user_id | string | No | (reference to HrisEmployee) |
channel.members[].email | string | No | |
channel.members[].name | string | No | |
channel.members[].image_url | string | No | |
channel.is_active | boolean | No | |
channel.is_private | boolean | No | |
channel.web_url | string | No | |
message | object | No | |
message.id | string | No | |
message.created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
message.updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
message.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". |
message.channels[].id | string | No | |
message.channels[].name | string | No | |
message.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.message_thread_identifier | string | No | the opaque identifier for the first message in a thread |
message.author_member | MessagingEvent_message_author_member | No | for email systems, this field represents the From value |
message.author_member.user_id | string | No | (reference to HrisEmployee) |
message.author_member.email | string | No | |
message.author_member.name | string | No | |
message.author_member.image_url | string | No | |
message.destination_members | MessagingMember[] | No | for email systems, this field represents the To value |
message.destination_members[].user_id | string | No | (reference to HrisEmployee) |
message.destination_members[].email | string | No | |
message.destination_members[].name | string | No | |
message.destination_members[].image_url | string | No | |
message.hidden_members | MessagingMember[] | No | for email systems, this field represents the BCC value |
message.hidden_members[].user_id | string | No | (reference to HrisEmployee) |
message.hidden_members[].email | string | No | |
message.hidden_members[].name | string | No | |
message.hidden_members[].image_url | string | No | |
message.mentioned_members | MessagingMember[] | No | for email systems, this field represents the CC value |
message.mentioned_members[].user_id | string | No | (reference to HrisEmployee) |
message.mentioned_members[].email | string | No | |
message.mentioned_members[].name | string | No | |
message.mentioned_members[].image_url | string | No | |
message.reactions | MessagingReaction[] | No | |
message.reactions[].reaction | string | Yes | |
message.reactions[].member | MessagingReaction_member | Yes | |
message.reactions[].member.user_id | string | No | (reference to HrisEmployee) |
message.reactions[].member.email | string | No | |
message.reactions[].member.name | string | No | |
message.reactions[].member.image_url | string | No | |
message.subject | string | No | |
message.message | string | No | |
message.message_html | string | No | |
message.message_markdown | string | No | |
message.attachments | MessagingAttachment[] | No | |
message.attachments[].filename | string | No | |
message.attachments[].size | number | No | |
message.attachments[].content_identifier | string | No | the inline attachment's content_id |
message.attachments[].content_type | string | No | |
message.attachments[].download_url | string | No | |
message.attachments[].message_id | string | No | |
message.web_url | string | No | |
message.reference | string | No | eg. RFC822 MessageID |
message.has_children | boolean | No | |
message.is_unread | boolean | No | |
message.buttons | MessagingButton[] | No | |
message.buttons[].id | string | Yes | |
message.buttons[].text | string | No | |
message.buttons[].icon | string | No | |
button | object | No | |
button.id | string | No | |
button.text | string | No | |
button.icon | string | No | |
user | object | No | |
user.id | string | No | |
user.name | string | No | |
is_replacing_original | boolean | No |
Are we missing anything? Let us know