Body

• name string

  The event name, if provided.

• data string

  The string encoded payload, with the encoding specified below.

• encoding string

  This will typically be empty as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute will contain the remaining transformations not applied to the data payload.

• clientId string

  The client ID of the publisher of this message.

• connectionId string

  The connection ID of the publisher of this message.

• extras object

  Extras object. Currently only allows for push extra.

  Hide extras attribute Show extras attribute object

  • push object
    Hide push attributes Show push attributes object

    • data string

      Arbitrary key-value string-to-string payload.

    • notification object
      Hide notification attributes Show notification attributes object

      • title string

        Title to display at the notification.

      • body string

        Text below title on the expanded notification.

      • icon string

        Platform-specific icon for the notification.

      • sound string

        Platform-specific sound for the notification.

      • collapseKey string

        Platform-specific, used to group notifications together.

    • apns object

      Extends and overrides generic values when delivering via APNs. See examples

      Hide apns attribute Show apns attribute object

      • notification object
        Hide notification attributes Show notification attributes object

        • title string

          Title to display at the notification.

        • body string

          Text below title on the expanded notification.

        • icon string

          Platform-specific icon for the notification.

        • sound string

          Platform-specific sound for the notification.

        • collapseKey string

          Platform-specific, used to group notifications together.

    • fcm object

      Extends and overrides generic values when delivering via GCM/FCM. See examples

      Hide fcm attribute Show fcm attribute object

      • notification object
        Hide notification attributes Show notification attributes object

        • title string

          Title to display at the notification.

        • body string

          Text below title on the expanded notification.

        • icon string

          Platform-specific icon for the notification.

        • sound string

          Platform-specific sound for the notification.

        • collapseKey string

          Platform-specific, used to group notifications together.

    • web object

      Extends and overrides generic values when delivering via web. See examples

      Hide web attribute Show web attribute object

      • notification object
        Hide notification attributes Show notification attributes object

        • title string

          Title to display at the notification.

        • body string

          Text below title on the expanded notification.

        • icon string

          Platform-specific icon for the notification.

        • sound string

          Platform-specific sound for the notification.

        • collapseKey string

          Platform-specific, used to group notifications together.