Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Amazon Chime events sent to chatbots - Amazon Chime

You must be an Amazon Chime system administrator to complete the steps in this guide. If you need help with the Amazon Chime desktop client, web app, or mobile app, see Getting support in the Amazon Chime User Guide.

You must be an Amazon Chime system administrator to complete the steps in this guide. If you need help with the Amazon Chime desktop client, web app, or mobile app, see Getting support in the Amazon Chime User Guide.

Amazon Chime events sent to chatbots

The following events are sent to your chatbot from Amazon Chime:

  • Invite – Sent when your chatbot is added to an Amazon Chime chat room

  • Mention – Sent when a user in a chat room @mentions your chatbot

  • Remove – Sent when your chatbot is removed from an Amazon Chime chat room

The following examples show the JSON payload sent to your chatbot for each of these events.

Example : Invite event
{ "Sender": { "SenderId": "user@example.com", "SenderIdType": "EmailId" }, "Discussion": { "DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st", "DiscussionType": "Room" }, "EventType": "Invite", "InboundHttpsEndpoint": { "EndpointType": "Persistent", "Url": "https://hooks.a.chime.aws/incomingwebhooks/a1b2c34d-5678-90e1-f23g-h45i67j8901k?token=ABCDefGHiJK1LMnoP2Q3RST4uvwxYZAbC56DeFghIJkLM7N8OP9QRsTuV0WXYZABcdefgHiJ" }, "EventTimestamp": "2019-04-04T21:27:52.736Z" }
Example : Mention event
{ "Sender": { "SenderId": "user@example.com", "SenderIdType": "EmailId" }, "Discussion": { "DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st", "DiscussionType": "Room" }, "EventType": "Mention", "InboundHttpsEndpoint": { "EndpointType": "ShortLived", "Url": "https://hooks.a.chime.aws/incomingwebhooks/a1b2c34d-5678-90e1-f23g-h45i67j8901k?token=ABCDefGHiJK1LMnoP2Q3RST4uvwxYZAbC56DeFghIJkLM7N8OP9QRsTuV0WXYZABcdefgHiJ" }, "EventTimestamp": "2019-04-04T21:30:43.181Z", "Message": "@botDisplayName@example.com Hello Chatbot" }
Note

The InboundHttpsEndpoint URL for a Mention event expires 2 minutes after it is sent.

Example : Remove event
{ "Sender": { "SenderId": "user@example.com", "SenderIdType": "EmailId" }, "Discussion": { "DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st", "DiscussionType": "Room" }, "EventType": "Remove", "EventTimestamp": "2019-04-04T21:27:29.626Z" }
PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.