For the complete documentation index, see llms.txt. This page is also available as Markdown.

Push token

Contains API calls to interact with push token.

Find information about push token usage in our instructions.

API actions

API path: /user/session/push_token.

bind

Binds Push token with a current session.

Parameters

name
description
type

application

Application ID, "navixy_iphone_viewer" or "navixy_android_viewer" or "w3c_pushapi".

token

Push token or endpoint from pushSubscription, full URL like https://fcm.googleapis.com/fcm/send/f6kicrBn7S0:APA91b if your app ID is " "

string

parameters

Should be used only with object with "w3c_pushapi". Contain keys from pushSubscription {"p256dh": "...", "auth":"..."}

JSON object

category_filter

Optional. Push notifications category filter, default is *.

string

Example

cURL

curl -X POST 'https://api.eu.navixy.com/v2/user/session/push_token/bind' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "application": "navixy_android_viewer", "token": "f4be7b9d04da2ce1af111b"}'

Response

Using category_filter you can filter out unwanted notifications categories.

If category_filter equals to * this means all categories allowed.

Delimited with comma list means that allowed only listed categories i.e. chat_message,history_rule.

Prepended with minus and delimited with comma list means that all categories allowed except given i.e. – history_task,history_rule.

Possible categories:

  • chat_message – notification about new chat message.

  • history_rule – notifications related to rule actuation.

  • history_task – notifications related to tasks.

  • history_info – service information.

  • history_service_task – service task notifications.

  • history_work_status – work status notifications.

Errors

delete

Deletes push token bound with the session.

Parameters

Only session hash.

Examples

Response

Errors

General types only.

Last updated

Was this helpful?