Conversation
Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).
Conversation
conversation_created
Definition: The event is emitted anytime a new conversation is initiated by the sender.
Trigger: Triggered when a new conversation is created.
Payload Example:
{
"metadata": {
"root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",
"root_account_id": "21070000000000001",
"root_account_lti_guid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs.oxana.instructure.com",
"user_account_id": "21070000000000001",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36",
"user_id": "21070000000000123",
"user_login": "[email protected]",
"user_sis_id": "456-T45",
"time_zone": "America/Denver",
"request_id": "1dd9dc6f-2fb0-4c19-a6c5-7ee1bf3ed295",
"session_id": "ef686f8ed684abf78cbfa1f6a58112b5",
"hostname": "oxana.instructure.com",
"http_method": "POST",
"client_ip": "93.184.216.34",
"url": "http://oxana.instructure.com/conversations",
"referrer": "http://oxana.instructure.com/conversations",
"producer": "canvas",
"event_name": "conversation_created",
"event_time": "2020-03-24T16:55:59.973Z"
},
"body": {
"conversation_id": "123456789",
"updated_at": "2018-09-24T06:00:00Z"
}
}Event Body Schema
conversation_id
The Canvas id of the conversation.
updated_at
The time this conversation was updated.
conversation_forwarded
Definition: The event is emitted when a conversation is updated.
Trigger: Triggered when a new user is added to a conversation
Payload Example:
Event Body Schema
conversation_id
The Canvas id of the conversation.
updated_at
The time this conversation was updated.
conversation_message_created
Definition: The event is emitted anytime a new conversation message is added to a conversation.
Trigger: Triggered when a new conversation mesage is created.
Payload Example:
Event Body Schema
author_id
The Canvas id of the author.
conversation_id
The Canvas id of the conversation.
created_at
The time this conversation message was created.
message_id
The Canvas id of the conversation message.
Note: Timestamps will be in ISO8601 format, including an offset. Be sure to take that into account when parsing, since it’s unspecified which offset timestamps will use, and the offset may even change between different timestamps within a single event.
This documentation is generated directly from the Canvas LMS source code, available on Github.
Last updated
Was this helpful?