Skip to main content

Forwarding of Events and Positions

For larger fleets, polling data via the API is not recommended, as it significantly increases server load. Instead, the I LOCK IT Cloud API supports event and position forwarding to external servers.

Key Features

  • Forward events and optionally positions to external endpoints.
  • Configure forwarding per device group.
  • Support for up to four forwarding endpoints (e.g., dev, qa, stage, prod).
  • Supports basic authentication with base64-encoded credentials.
  • IP filtering is recommended to secure access (use 192.71.151.108).

Authentication

  • Method: POST
  • Endpoint: https://tracking.ilockit.bike/api/groups/forwarder
  • Authentication: Basic authentication (email and password)
  • Header:
    accept: application/json

Request Body Parameters

All parameters are passed as a JSON object:

KeyTypeRequiredDescription
groupIdIntegerID of the group
devURLStringDev endpoint URL
devHeaderStringDev HTTP auth header
devForwardPositionBooleanForward position to dev
qaURLStringQA endpoint URL
qaHeaderStringQA HTTP auth header
qaForwardPositionBooleanForward position to QA
stageURLStringStage endpoint URL
stageHeaderStringStage HTTP auth header
stageForwardPositionBooleanForward position to stage
prodURLStringProduction endpoint URL
prodHeaderStringProduction HTTP auth header
prodForwardPositionBooleanForward position to production

⚠️ All endpoints must be submitted together. Previous configurations will be overwritten.

Example Request Body

{
"groupId": 27,
"devURL": "https://your.domain.com/devEndpoint",
"stageURL": "https://your.domain.com/stageEndpoint",
"stageHeader": "Authorization: Basic dXNlcjpwYXNzd29yZA==",
"stageForwardPosition": true,
"prodURL": "https://your.prodDomain.com/endpoint",
"prodHeader": "Authorization: Basic dXNlcjpwYXNzd29yZA==",
"prodForwardPosition": true
}

Responses

CodeDescription
200Success
400Bad Request
401Unauthorized