Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14179784.8 KB

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

post/SendEvent

Request body

roomIdentifierstring required

Identifier of the room to which the event will be sent. Currently this must be an ARN.

eventNamestring required

Application-defined name of the event to send to clients.

attributesobject

Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

Response

Success

idstring

An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.