Base URL
https://{tenant}.logzi.com/api/push/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A push notification is a system message shown in the mobile app. It can also be used to alert on internal events (new task, receipt status change).
/api/push/get
Retrieve a single push notification by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the push notification |
Example request
GET /api/push/get?id=30
X-API-KEY: {your_api_key}/api/push/list
Retrieve a paginated list of push notifications with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition[company_id] | int | Filter by company identifier | |
list_condition[company_user_id] | int | Filter by staff member identifier | |
list_condition[company_user_id_or_null] | int | Filter by staff member OR all (NULL) notifications |
Example request
GET /api/push/list?list_condition[company_user_id]=3&list_offset=0
X-API-KEY: {your_api_key}/api/push/save
Create a push notification (new entry). For an existing entry, only status_id can be changed. For a new notification use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new notification, >0 = status change | |
status_id | int | Status of the notification | |
company_user_id | int | Target staff member (if NULL: all users) | |
partner_id | int | Identifier of the related partner | |
receipt_id | int | Identifier of the related receipt | |
receipt_type_id | int | Type of the receipt | |
push_level | int | Importance level (1=info, 2=warning, 3=critical) | |
push_title | string | Title of the notification | |
push_description | string | Text of the notification |
Example request
POST /api/push/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"status_id": 1,
"company_user_id": 3,
"push_level": 2,
"push_title": "Új rendelés érkezett",
"push_description": "Webshopból érkezett egy rendelés.",
"receipt_id": 501,
"receipt_type_id": 11
}
}Create your account now,
pay later!
