Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Before opening a WebSocket you have to create a session first.

See the following two sample projects (HTML/Javascript client and Node.js client).

Sample

...

WebSocket API Client

  1. Web - Here you can find a (non-complete)

...

  1. web project (HTML / Javascript), showing how to draw the devices of an account on a map

...

  1. including WebSocket live updates

...

  1. .

...

  1. Node.js

...

  1. - Here we provide a simple script to subscribe to your BikeTrax event stream and either print it to stdout or process it as you wish. In the sample script we log the events and forward them to a local http endpoint of choice

...

  1. .

Webhook Integration

The BikeTrax Cloud can be configured to call a HTTP(S) endpoint of your choice for every new event generated by your devices' activity.

...

  1. Log in to https://traccar.powunity.com

  2. click Settings at the top right:

  3. Select Account

  4. Click on the Attributes button in the dialog that opened

  5. Use the + button to add the following attributes to the table - NOTE: Attribute names are case sensitive!

    1. webhookUrl This is the URL that will be called on every new event via a HTTP POST request. We highly encourage to use a URL starting with https:// but http:// is also supported for testing purposes.

    2. webhookPsk Optional. If set, the HTTP(S) requests will contain a Authorization header with this attribute’s data as value. This should allow Basic and Bearer authorization methods to be implemented easily.

    3. webhookTypes Optional. If set, this should be a comma (,) separated list of event types which are to be forwarded by the webhook. If this attribute is not present then all events are sent. Some useful possible values are: deviceOnline, deviceOffline, deviceMoving, deviceStopped, alarm, geofenceEnter, geofenceExit, ignitionOn, ignitionOff

    4. Here is what the Attributes dialog could look like:

      Image RemovedImage Added
  6. Once the attributes are set close the Attributes and Account dialogs. The webhooks are then activated immediately.

...