Definition

Event resources behave differently depending on their event type. The following table gives an overview of which event type implies what functionality.

Click on the type to get a detailed view on the events content.

Public event types

Table 1.
type scope deletable ephemeral annotatable
s.change Global
s.delete Room
s.form Room
s.form.submission Room
s.invitation Room
s.mention Room
s.message.action Room
s.message.action.invocation Room
s.message.action.invocation.validation Room
s.message.edit Room
s.message.media Room
s.message.preview Room
s.message.preview.track Room
s.message.text Room
s.message.text.translation Room
s.presence Global
s.receipt Room
s.room.blocked Room
s.room.close Room
s.room.create Room
s.room.membership Room
s.room.pin Room
s.room.setting Room
s.room.typing Room
s.room.user.setting Room
s.support.close Room
s.support.delegate Room
s.support.inactive Room
s.support.open Room
s.support.request Room
s.support.request.rejected Room
s.timer Room

Scope

The scope of an event is not part of an Event's attribute set, but part of its definition. The scope specifies where the event is defined to occur. Currently the following scopes are defined:

  • Room - Event can only be observed in a room.

  • Global - Event can only be observed globally, i.e. without a reference to a room.

Deletability

Specifies if an event can be deleted.

Ephemeral event

An ephemeral event cannot be retrieved via Events resource. It can only be observed by sync. The ephemerality of an event is not part of its attribute set, but part of its definition.

Annotatable

Specifies if an event can be annotated.