Skip to content
Capturit Backend Docs

Ably

Here is a list of API endpoints of Ably.

PUT 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.

This is an example of using /ably/ping:

Terminal window
curl -X 'PUT' \
    'http://localhost:8080/api/ably/ping' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_TOKEN' \

Responses

Code: 200
Description: Ok: The request was successful

Code: 401
Description: Unaunthorized: The request requires valid bearer token, but none were provided, or the bearer token is invalid.

Code: 429
Description: Too Many Requests: The user has exceeded the rate limit of 10 requests per minute.

Code: 500
Description: Internal Server Error: There is an issue with the backend. Sentry will provide a more detailed report on the problem.

PUT ably/disconnect

This is used to inform the backend that the application is inactive. Its purpose is to send all the notification via FCM.

This is an example of using /ably/disconnect:

Terminal window
curl -X 'DELETE' \
    'http://localhost:8080/api/ably/disconnect' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_TOKEN' \

Responses

Code: 200
Description: Ok: The request was successful

Code: 401
Description: Unaunthorized: The request requires valid bearer token, but none were provided, or the bearer token is invalid.

Code: 429
Description: Too Many Requests: The user has exceeded the rate limit of 10 requests per minute.

Code: 500
Description: Internal Server Error: There is an issue with the backend. Sentry will provide a more detailed report on the problem.