---
title: "Check push"
method: POST
path: "/check_push"
tags: ["product:chat"]
---

# Check push

`POST /check_push`

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

## Request body

- CheckPushRequest, nullable — Check push request
  - `apn_template` string — Push message template for APN
  - `event_type` 'message.new' | 'message.updated' | 'reaction.new' | 'reaction.updated' | 'notification.reminder_due' — Type of event for push templates (default: message.new). One of: message.new, message.updated, reaction.new, reaction.updated, notification.reminder_due
  - `firebase_data_template` string — Push message data template for Firebase
  - `firebase_template` string — Push message template for Firebase
  - `message_id` string — Message ID to send push notification for
  - `push_provider_name` string — Name of push provider
  - `push_provider_type` string — Push provider type. One of: firebase, apn, huawei, xiaomi
  - `skip_devices` boolean — Don't require existing devices to render templates
  - `user` UserRequest — User request object
    - `custom` object — Custom user data
    - `id` string, required — User ID
    - `image` string — User's profile image URL
    - `invisible` boolean
    - `language` string
    - `name` string — Optional name of user
    - `privacy_settings` PrivacySettingsResponse
      - `delivery_receipts` DeliveryReceiptsResponse
        - `enabled` boolean
      - `read_receipts` ReadReceiptsResponse
        - `enabled` boolean
      - `typing_indicators` TypingIndicatorsResponse
        - `enabled` boolean
    - `role` string — User's global role
    - `teams` string[] — List of teams the user belongs to
    - `teams_role` object — Map of team-specific roles for the user
  - `user_id` string

## Response `201`

Successful response

- CheckPushResponse, nullable
  - `device_errors` object — Object with device errors
  - `duration` string, required
  - `event_type` string — The event type that was tested
  - `general_errors` string[] — List of general errors
  - `rendered_apn_template` string
  - `rendered_firebase_template` string
  - `rendered_message` object
  - `skip_devices` boolean — Don't require existing devices to render templates

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/getstream/apis/stream-api.md) · [All operations](https://skmtc.net/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getstream/stream-api/versions/3dba86aaa0d8/schema)