Chat Webhooks

string — The ID of the space that was left.

string — The name of the space that was left.

integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

object — Information about the invitee.

array — Information about the inviters.

integer, format: int64 — The timestamp for when the chat channel invitation was removed.

object — Information about the chat channel. This object is blank for external channel.

string, format: date-time — The date and time at which the chat channel invitation was removed, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about organization of channel owner. This object is blank for external organization.

string — The custom emoji's file ID.

string — The custom emoji's name.

array — The files' information.

string, format: date-time — The date and time at which the chat channel join request was declined, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about the requester.

integer, format: int64 — The timestamp for when the chat channel join request was declined.

object — Information about the chat channel. This object is blank for external channel.

object — Information about organization of channel owner. This object is blank for external organization.

string, possible values: "by_channel_owner_account_admin", "by_requester_account_admin", "by_channel_owner" — The operation type of this event: * `by_channel_owner_account_admin` — The join request is approved or declined by channel owner account admin. * `by_requester_account_admin` — The join request is approved or declined by requester account admin. * `by_channel_owner` — The join request is approved or declined by channel owner.

string, format: date-time — The date and time at which the user joined the chat channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the user joined the chat channel.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string — The chat channel's ID.

string — The chat channel's name.

string — The email address of the message contact to whom the message was sent.

string — The message contact's user ID.

string, format: date-time — The date and time at which the message was updated, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's unique ID.

string — The updated message content.

string — The chat session's unique ID.

integer, format: int64 — The timestamp for when the message was updated.

string, possible values: "to_contact", "to_channel" — Whether the message was sent to a chat channel or an individual contact: * `to_contact` — The message was sent to a contact. * `to_channel` — The message was sent to a chat channel.

string, format: date-time — The date and time at which the chat channel was deleted, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the chat channel was deleted.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string — The chat channel's ID.

string — The chat channel's name.

string — The email address of the contact to whom the message was sent.

string — The message contact's user ID.

string, format: date-time — The date and time at which the message was deleted, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's unique ID.

string — The deleted message content.

string — The chat session's unique ID.

integer, format: int64 — The timestamp for when the message was deleted.

string, possible values: "to_contact", "to_channel" — Whether the message was sent to a chat channel or an individual contact: * `to_contact` — The message was sent to a contact. * `to_channel` — The message was sent to a chat channel.

string — The custom emoji's file ID.

string — The custom emoji's name.

string — The chat channel's ID.

string — The chat channel's name.

string, format: date-time — The date and time at which the chat message was pinned, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The pinned message's content.

string — The pinned message's ID.

integer, format: int64 — The timestamp for when the pinned message was sent.

integer, format: int64 — The timestamp for when the chat message was pinned.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

array — The files info in the pinned message's content. Only when the pinned message contains files, the payload will include the `files`.

array — The [rich text formatting](https://support.zoom.us/hc/en-us/articles/115004789183-Replying-to-and-managing-chat-messages) info included in the pinned message. Only when the pinned message contains rich texts, the payload will include the `rich_text`.

string, format: email — The email address of the contact to whom the emoji was added. This value returns an empty string for external users.

string — The user ID of the contact to whom the emoji was added. This value returns an empty string for external users.

string — The member ID of the contact to whom the emoji was added.

string — If the emoji is customzied, it returns the emoji's name. If the emoji is default, it will return unicode of this emoji.

string, format: date-time — The date and time at which the emoji was added to the message, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The ID of chat message where the emoji was added

string, format: date-time — The date and time at which the message was added, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

integer, format: int64 — The timestamp for when the emoji was added to a message.

string, format: date-time — The date and time at which the chat channel was archived, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's ID.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the chat channel was archived.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

boolean — Whether this message was sent by an external user.

string, format: date-time — The date and time at which the message was unbookmarked, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The unbookmarked message's content.

string — The unbookmarked message's ID.

integer, format: int64 — The timestamp for when the unbookmarked message was sent.

string — The message sender's email address. If this message was sent by an external user and the `type` is `to_channel`, the value of the `sender` will be an empty string.

string — The message sender's user ID. If this message was sent by an external user, the value of the `sender_id` will be an empty string.

string — The message sender's member ID.

integer, format: int64 — The timestamp for when the message was unbookmarked.

string, possible values: "to_contact", "to_channel" — The type of message: * `to_contact` — The message was sent to a contact. * `to_channel` — The message was sent to a chat channel.

string — The chat channel's ID. Only when the `type` is `to_channel`, the payload will include the `channel_id`.

array — The files info in the unbookmarked message's content. Only when the unbookmarked message contains files, the payload will include the `files`.

array — The [rich text formatting](https://support.zoom.us/hc/en-us/articles/115004789183-Replying-to-and-managing-chat-messages) info included in the unbookmarked message. Only when the unbookmarked message contains rich texts, the payload will include the `rich_text`.

string — The chat channel's ID.

string — The chat channel's name.

string, format: date-time — The date and time at which the chat message was unpinned, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The unpinned message's content.

string — The unpinned message's ID.

integer, format: int64 — The timestamp for when the unpinned message was sent.

integer, format: int64 — The timestamp for when the chat message was unpinned.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

array — The files info in the unpinned message's content. Only when the unpinned message contains files, the payload will include the `files`.

array — The [rich text formatting](https://support.zoom.us/hc/en-us/articles/115004789183-Replying-to-and-managing-chat-messages) info included in the unpinned message. Only when the unpinned message contains rich texts, the payload will include the `rich_text`.

string, format: date-time — The date and time at which this approval request is sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about the requester.

integer, format: int64 — The timestamp for when this approval request is sent.

string, possible values: "to_channel_account_admin", "to_requester_account_admin", "to_channel_owner" — The type of this approval request: * `to_requester_account_admin` — The request needs approval of requster account admin. * `to_channel_account_admin` — The request needs approval of channel owner account admin. * `to_channel_owner` — The request needs approval of channel owner.

object — Information about the chat channel. This object is blank for external channel.

object — Information about organization of channel owner. This object is blank for external organization.

object — Information about the team chat message file.

integer, format: int64 — The timestamp when the message was sent.

string — The team chat channel's ID. This field only displays when the file was sent in the chat channel.

string, format: email — The email address of the contact. This field only displays when the file was sent in a one-on-one chat between the operator and the contact. This value returns an empty string for external users

string — The file message contact's user ID. This field only display when the file was sent in a one-on-one chat between the operator and the contact. This value returns an empty string for external users.

string — The file message contact's member ID. This field only displays when the file was sent in a one-on-one chat between the operator and the contact.

string — The message contact's account ID.The value will be an empty string if this info is from an external user.

string, format: email — The email address of the contact to whom the message was sent.

string — The message contact's user ID.The value will be an empty string if this info is from an external user.

string — The message contact's member ID.

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's ID.

string — The chat session's unique ID.

integer, format: int64 — The timestamp for when the message was sent.

array — The attachment file's info in sent message's content.

string — The sent message's content.If this event only occurs when sending a file, the value of the `message` will not exist.

string — The ID of the parent message in the chat thread.It's only available if the message is a reply to a main message in a thread.

array — The [rich text formatting](https://support.zoom.us/hc/en-us/articles/115004789183-Replying-to-and-managing-chat-messages)object. Use this object to include rich text info in sent message's content.

object — Information about the shared space's new settings.

object — Information about the shared space's old settings.

string — The ID of the space.

integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

string, format: date-time — The date and time at which the chat channel was updated, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

string — The chat channel's name.

integer, format: int64 — The chat channel's update timestamp.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string — The chat channel's ID.

string — The chat channel's name.

string, format: date-time — The date and time at which the chat bot was added to the chat channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

integer, format: int64 — The timestamp for when the chat bot was added to the chat channel.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

array — Information about added chat bot app members.

string, format: date-time — The date and time at which the sessions were starred, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

array — The sessions' info.

integer, format: int64 — The timestamp for when the sessions were starred.

string — The chat channel's ID.

string — The chat channel's name.

string — The chat channel owner’s account ID.The value will be an empty string if this info is from an external user.

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's ID.

integer, format: int64 — The timestamp for when the message was sent.

string — The ID of the parent message in the chat thread.It's only available if the message is a reply to a main message in a thread.

string, format: date-time — The date and time at which the chat channel was created, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

array — Information about the chat channel's members.

string — The chat channel's name.

integer, format: int64 — The chat channel's creation timestamp.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string, format: date-time — The date and time at which the user was invited to join the chat channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

array — Information about the chat channel's members.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the user was invited to join the chat channel.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

object — Information about the invitee.

array — Information about the inviters.

integer, format: int64 — The timestamp for when the chat channel invitation was accepted.

object — Information about the chat channel. This object is blank for external channel.

string, format: date-time — The date and time at which the chat channel invitation was accepted, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about organization of channel owner. This object is blank for external organization.

string, format: date-time — The date and time at which the user left the chat channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the user left the chat channel.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string, format: date-time — The date and time at which the user who requested to join this channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about the requster.

integer, format: int64 — The timestamp for when user requested to join this channel.

object — Information about the chat channel. This object is blank for external channel.

object — Information about organization of channel owner. This object is blank for external organization.

string — The message contact's account ID.The value will be an empty string if this info is from an external user.

string, format: email — The email address of the contact to whom the message was sent.

string — The message contact's user ID. The value will be an empty string if this info is from an external user.

string — The message contact's member ID.

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's ID.

string — The chat session's unique ID.

integer, format: int64 — The timestamp for when the message was sent.

array — The attachment file's info in sent message's content.

string — The sent message's content.If this event only occurs when sending a file, the value of the `message` will not exist.

string — The ID of the parent message in the chat thread. It's only available if the message is a reply to a main message in a thread.

array — The [rich text formatting](https://support.zoom.us/hc/en-us/articles/115004789183-Replying-to-and-managing-chat-messages)object. Use this object to include rich text info in sent message's content.

string — The unique ID of the channel in which the message reply was sent.

string — The name of the channel in which the message reply was sent.

string — The email address of the contact to whom the message reply was sent.

string — The user ID of the contact to whom the message reply was sent.

string, format: date-time — The date and time of the message reply, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's unique ID.

string — The message reply's contents.

string — The unique ID of the parent message in the chat thread (the chat message to which the message reply was sent).

string — The chat session's unique ID.

integer, format: int64 — The timestamp for the message reply.

string, possible values: "to_contact", "to_channel" — Whether the message reply was sent to a chat channel or an individual contact: * `to_contact` — The message was sent to a contact. * `to_channel` — The message was sent to a chat channel.

string, format: date-time — The date and time at which the chat channel invitation was rejected, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about the invitee.

array — Information about the inviters.

integer, format: int64 — The timestamp for when the chat channel invitation was rejected.

object — Information about the chat channel. This object is blank for external channel.

object — Information about organization of channel owner. This object is blank for external organization

string — The chat channel's ID.

string — If the emoji is customzied, it returns the emoji's name. If the emoji is default, it will return unicode of this emoji.

string, format: date-time — The date and time at which the emoji was removed to the message, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The ID of chat message where the emoji was removed

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

integer, format: int64 — The timestamp for when the emoji was removed to a message.

array — The invited members.

string — The ID of the space the user(s) was/were invited to.

string — The name of the space the user(s) was/were invited to.

integer, format: int64 — A timestamp, in milliseconds since epoch, at which the event occurred.

string, format: date-time — The date and time at which the sessions were unstarred, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

array — The sessions' info.

integer, format: int64 — The timestamp for when the sessions were unstarred.

array — The files' information.

string, possible values: "to_contact", "to_channel" — The type of the files: * `to_contact` — The files were sent to a contact. * `to_channel` — The files were sent to a channel.

string — The ID of the channel to which the files were unshared. Only when the `type` is `to_channel`, the payload will include the `channel_id`.

string, format: email — The email address of the contact to whom the files were unshared. Only when the `type` is `to_contact`, the payload will include the `contact_email`.

string — The user ID of the contact to whom the files were unshared. Only when the `type` is `to_contact`, the payload will include the `contact_id`. If this contact is an external user, the `contact_id` will be an empty string.

string — The member ID of the contact to whom the files were unshared. Only when the `type` is `to_contact`, the payload will include the `contact_member_id`.

boolean — Whether this contact is an external user. Only when the `type` is `to_contact`, the payload will include the `is_external_user`.

string, format: date-time — The date and time at which the member was removed from the chat channel, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's unique ID.

array — Information about the chat channel's members.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the member was removed from the chat channel.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string, format: email — The email address of the contact to whom the emoji was added. This value returns an empty string for external users.

string — The user ID of the contact to whom the emoji was added. This value returns an empty string for external users.

string — The member ID of the contact to whom the emoji was added. This value returns an empty string for external users.

string — If the emoji is customzied, it returns the emoji's name. If the emoji is default, it will return unicode of this emoji.

string, format: date-time — The date and time at which the emoji was removed to the message, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The ID of chat message where the emoji was removed

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

integer, format: int64 — The timestamp for when the emoji was removed to a message.

string — The message contact's account ID.The value will be an empty string if this info is from an external user.

string, format: email — The email address of the contact to whom the message was sent.

string — The message contact's user ID.The value will be an empty string if this info is from an external user.

string — The message contact's member ID.

string, format: date-time — The date and time at which the message was sent, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The message's ID.

integer, format: int64 — The timestamp for when the message was sent.

string — The ID of the parent message in the chat thread.It's only available if the message is a reply to a main message in a thread.

string, format: date-time — The date and time at which the chat channel was unarchived, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

string — The chat channel's ID.

string — The chat channel's name.

integer, format: int64 — The timestamp for when the chat channel was unarchived.

integer, possible values: 1, 2, 3, 4, 5 — The type of chat channel: * `1` — Private chat channel. Only invited members can join. * `2` — Private chat channel with the same account. Only invited members who are in the same Zoom account as the chat channel's creator can join. * `3` — Public chat channel. Anyone can search for and join this chat channel. * `4` — An instant channel. This type of channel is created by adding members to a new chat. * `5` — A public channel. Anyone can join this channel and invite members from other Zoom accounts.

string, format: date-time — The date and time at which the chat channel join request was approved, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

object — Information about the requester.

integer, format: int64 — The timestamp for when the chat channel join request was approved.

object — Information about the chat channel. This object is blank for external channel.

object — Information about organization of channel owner. This object is blank for external organization.

string, possible values: "by_channel_owner_account_admin", "by_requester_account_admin", "by_channel_owner" — The operation type of this event: * `by_channel_owner_account_admin` — The join request is approved or declined by channel owner account admin. * `by_requester_account_admin` — The join request is approved or declined by requester account admin. * `by_channel_owner` — The join request is approved or declined by channel owner.