Post
/api/v1/push.test
Use this endpoint to test the push notifications configuration. The response indicates how many registered devices received the test notification.
To test successfully, make sure that you have logged into the workspace on the Rocket.Chat mobile app. By default, one request is allowed every 1000 milliseconds.
Permission required:
test-push-notifications
Changelog
| Version | Description |
|---|---|
| 8.8.0 | Added the message and params response fields. |
Header parameters
X-Auth-Token
stringRequired
The authorization token of the user.
Example9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq
X-User-Id
stringRequired
The user ID of the user.
ExampleaobEdbYhXfu5hkeqG
Responses
200
OK
Example 1
{
"tokensCount": 1,
"message": "Your_push_was_sent_to_s_devices",
"params": [
1
],
"success": true
}object
tokensCount
integer
The number of devices to which the test notification was sent.
message
string
The translation key for the test result message.
params
Array of integer
Values used to format the translated result message.
integer
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string