Ping

GET api/ably/ping

This is used to inform the backend that the application is active. The purpose is to determine where to send notifications.

We use Ably when the application is active and Firebase Cloud Messaging (FCM) to send push notifications.

Important

This API endpoint requires an authorization token.

Note

Ably supports FCM for push notifications, but we were unable to make it work on mobile, so we are using vanilla FCM.

Example Request

curl -X 'PUT' \
    'http://localhost:8080/api/ably/ping' \
    -H 'Authorization: Bearer YOUR_TOKEN'

Responses

200 - OK

The request was successful

Content Type: text/plain
Content:

Pong!

401 - Unauthorized

The request requires valid bearer token, but none were provided, or the bearer token is invalid.

429 - Too Many Requests

The user has exceeded the rate limit of 10 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.