GEgetstream
product:chat

Check push

Changed on

Sends a test message via push, this is a test endpoint to verify your push settings

post/check_push

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/check_push
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

apn_templatestring

Push message template for APN

event_type'message.new' | 'message.updated' | 'reaction.new' | 'reaction.updated' | 'notification.reminder_due' | 'feeds.activity.added' | 'feeds.comment.added' | 'feeds.activity.reaction.added' | 'feeds.comment.reaction.added' | 'feeds.follow.created' | 'feeds.notification_feed.updated'

Type of event for push templates (default: message.new). One of: message.new, message.updated, reaction.new, reaction.updated, notification.reminder_due, feeds.activity.added, feeds.comment.added, feeds.activity.reaction.added, feeds.comment.reaction.added, feeds.follow.created, feeds.notification_feed.updated

firebase_data_templatestring

Push message data template for Firebase

firebase_templatestring

Push message template for Firebase

message_idstring

Message ID to send push notification for

push_provider_namestring

Name of push provider

push_provider_typestring

Push provider type. One of: firebase, apn, huawei, xiaomi

skip_devicesboolean

Don't require existing devices to render templates

user_idstring

Response

Successful response

device_errorsobject

Object with device errors

durationstring required
event_typestring

The event type that was tested

general_errorsstring[]

List of general errors

rendered_apn_templatestring
rendered_firebase_templatestring
rendered_messageobject
skip_devicesboolean

Don't require existing devices to render templates

Changes

  • ddeb57744df3Revision changes
    • info

      added the new feeds.activity.added enum value to the request property

    • info

      added the new feeds.activity.reaction.added enum value to the request property

    • info

      added the new feeds.comment.added enum value to the request property

    • info

      added the new feeds.comment.reaction.added enum value to the request property

    • info

      added the new feeds.follow.created enum value to the request property

    • info

      added the new feeds.notification_feed.updated enum value to the request property

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status