Fleet setup

Notifications

User notifications management

Fetch a list of Notifications

GET

https://demo.traccar.org/api/notifications

Without params, it returns a list of Notifications the user has access to

Fetch a list of Notifications

curl -X GET 'https://demo.traccar.org/api/notifications' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/notifications',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "type": "string",
    "description": "string",
    "always": true,
    "commandId": 0,
    "notificators": "string",
    "calendarId": 0,
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

deviceIdintegerquery

Standard users can use this only with _deviceId_s, they have access to

groupIdintegerquery

Standard users can use this only with _groupId_s, they have access to

refreshbooleanquery

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Notification>

Response fields application/json

Array<Notification>

Show child attributes

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Notification

POST

https://demo.traccar.org/api/notifications

Create a Notification

curl -X POST 'https://demo.traccar.org/api/notifications' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/notifications', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}'''

response = requests.post(
    'https://demo.traccar.org/api/notifications',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

Response

200OKNotification

Response fields application/json

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Notification

GET

https://demo.traccar.org/api/notifications/{id}

Fetch a Notification

curl -X GET 'https://demo.traccar.org/api/notifications/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/notifications/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKNotification

Response fields application/json

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Notification

PUT

https://demo.traccar.org/api/notifications/{id}

Update a Notification

curl -X PUT 'https://demo.traccar.org/api/notifications/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/notifications/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/notifications/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "type": "string",
  "description": "string",
  "always": true,
  "commandId": 0,
  "notificators": "string",
  "calendarId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

Parameters

idintegerrequiredpath

Response

200OKNotification

Response fields application/json

idinteger<int64>

Unique identifier for the notification

typestring

Notification category such as geofenceEnter or ignitionOn

descriptionstring | null

User-defined text describing the notification

alwaysboolean

Whether the notification triggers regardless of schedule

commandIdinteger<int64>

Identifier of the command to send when the notification triggers

notificatorsstring

Comma-separated delivery channels (for example, web, mail)

calendarIdinteger<int64>

Calendar identifier restricting when the notification is active

attributesobject

Additional custom attributes used by notificators or templates

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Notification

DELETE

https://demo.traccar.org/api/notifications/{id}

Delete a Notification

curl -X DELETE 'https://demo.traccar.org/api/notifications/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/notifications/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a list of available Notification types

GET

https://demo.traccar.org/api/notifications/types

Fetch a list of available Notification types

curl -X GET 'https://demo.traccar.org/api/notifications/types' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/types', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/notifications/types',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "type": "string"
  }
]

Response

200OKArray<NotificationType>

Response fields application/json

Array<NotificationType>

Show child attributes

typestring

Notification type identifier

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a list of available Notificators

GET

https://demo.traccar.org/api/notifications/notificators

Fetch a list of available Notificators

curl -X GET 'https://demo.traccar.org/api/notifications/notificators' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/notificators', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/notifications/notificators',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "type": "string"
  }
]

Parameters

announcementbooleanquery

When true, exclude notificators that cannot deliver announcements

Response

200OKArray<NotificationType>

Response fields application/json

Array<NotificationType>

Show child attributes

typestring

Notification type identifier

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Send test notification to current user via Email and SMS

POST

https://demo.traccar.org/api/notifications/test

Send test notification to current user via Email and SMS

curl -X POST 'https://demo.traccar.org/api/notifications/test' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/test', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/notifications/test',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Response

204No Content

Successful sending

400Bad Request

Could happen if sending has failed

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Send a test notification to the current User using the specified notificator

POST

https://demo.traccar.org/api/notifications/test/{notificator}

Send a test notification to the current User using the specified notificator

curl -X POST 'https://demo.traccar.org/api/notifications/test/string' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/notifications/test/string', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/notifications/test/string',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

notificatorstringrequiredpath

Response

204No Content

Successful sending

400Bad Request

Could happen if sending has failed

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Send a custom notification to selected users using the specified notificator

POST

https://demo.traccar.org/api/notifications/send/{notificator}

Send a custom notification to selected users using the specified notificator

curl -X POST 'https://demo.traccar.org/api/notifications/send/string' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "subject": "string",
  "digest": "string",
  "body": "string",
  "priority": true
}'

const body = `{
  "subject": "string",
  "digest": "string",
  "body": "string",
  "priority": true
}`;

const response = await fetch('https://demo.traccar.org/api/notifications/send/string', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "subject": "string",
  "digest": "string",
  "body": "string",
  "priority": true
}'''

response = requests.post(
    'https://demo.traccar.org/api/notifications/send/string',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "subject": "string",
  "digest": "string",
  "body": "string",
  "priority": true
}

Body

application/json

subjectstring

Subject or title of the notification

digeststring

Short summary shown in compact contexts; defaults to the body when omitted

bodystringrequired

Full notification text

priorityboolean

Whether the message should be treated as high priority

Parameters

notificatorstringrequiredpath

userIdArray<integer>query

Optional list of user ids to send the notification to; if omitted, sends to all permitted users

Response

204No Content

Successful sending

400Bad Request

Could happen if sending has failed

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey