fcm
prefix. This is a device token that is issued by both the web and mobile firebase SDKs. You will also need to setup Firebase credentials in your application for the messages to deliver. For more information refer to the LINK(Setting up firebase) section in the reference documentation.TimelineEvents
are also pushed to the relevant users to their endpoints. All entities differ slightly in their signature from their mitter counterparts.NewMessagePayload
is delivered to a user that the user should be receiving as a part of their participation in a channel. A message model that is delivered looks like:NewChannelPayload
is delivered to a user whenever a user should be notified that a new channel is created. This is computed if a user happens to have read access to the channel, even if the user is not a participant. The model looks like:NewMessageTimelineEvent
is sent to a user with the same semantics as that of receiving a message. If a user is a target for receiving a message, they are also a target for every timeline event on that message. The model of that:data
field is a String, which means that the value of the field needs to be deserialized to one of the messaging pipeline payloads. The type of the sent payload is mentioned in the @type
field of the deserialized value of the data
field.notification
field, which is used by FCM to automatically display notifications on the user device, refer to the next section.notification
needs to be set with values for body
, title
and icon
. Since mitter messages do not offer direct access to it, you can use specific messageDatum objects with the dataType as cloud-notification
to denote to the FCM delivery facilitator to push the data as a notification. For future mechanisms, this API will continue to be supported with a similar model.POST
call. By default, only the user can register an endpoint for themselves and .system
can do it for any user. This behavior currently cannot be overridden.204
/v1/users/me/delivery-endpoints
.DELETE
call. By default, only the user can register an endpoint for themselves and .system
can do it for any user. This behavior currently cannot be overridden.204