Integrations

Webhook Event Reference

Reference the in-game events included in job webhook payloads.

#Event Payload

Payloads for events triggered in-game.

{
  "location": {
    "x": -104003.5436,
    "y": 11.0771,
    "z": 17014.155
  },
  "real_time": "2023-03-01T00:36:12Z",
  "time": 1677630973,
  "type": "job.started",
  "meta": {
    ...
  }
}

#Event types

#Job Started

Type: job.started This event is triggered when the job is started.

Meta Properties

Property	Type	Description
autoLoaded	`boolean`	If the job was automatically loaded.

#Job Delivered

Type: job.delivered This event is triggered when the job is delivered.

Meta Properties

Property	Type	Description
revenue	`int`	Revenue given from job
earnedXP	`int`	XP from the Job
cargoDamage	`float`	Cargo Damage
distance	`int`	Distance travelled
timeTaken	`int`	Time taken to complete job
autoPark	`boolean`	If auto parked

#Job Cancelled

Type: job.cancelled This event is triggered when the job is cancelled.

Meta Properties

Property	Type	Description
penalty	`int`	Penalty cost from cancelling job

#Fine

Type: fine This event is triggered when the fine is issued.

Meta Properties

Property	Type	Description
offence	`string`	The offence committed
amount	`int`	The fee amount in Euros or Dollars

If the fine offence was a speeding_camera:

Property	Type	Description
speed_limit	`int`	speed limit in km/h
amount	`int`	speed in km/h

#Tollgate

Type: tollgate This event is triggered when a tollgate is used.

Meta Properties

Property	Type	Description
cost	`int`	Cost to go through tollgate in Euros or Dollars

#Ferry

Type: ferry This event is triggered when a ferry is used.

Meta Properties

Property	Type	Description
cost	`int`	Cost to go through tollgate in Euros or Dollars
source_id	`string`	starting location ID
source_name	`string`	Starting location name (in native language)
target_id	`string`	Ending Location ID
target_name	`string`	Ending Location Name (in native language)

#Train

Type: train This event is triggered when a train is used in game.

Meta Properties

Property	Type	Description
cost	`int`	Cost to go through tollgate in Euros or Dollars
source_id	`string`	starting location ID
source_name	`string`	Starting location name (in native language)
target_id	`string`	Ending Location ID
target_name	`string`	Ending Location Name (in native language)

#Collision

Type: collision This event is triggered when a driver causes a collision

Meta Properties

Property	Type	Description
wear_engine	`int`	Truck Engine Damage (%)
wear_chassis	`string`	Truck Chassis Damage (%)
wear_transmission	`string`	Truck Transmission Damage (%)
wear_cabin	`string`	Truck Cabin damage (%)
wear_wheels	`string`	Truck wheel damage (%)

#Repair

Type: repair This event is triggered when truck is repaired.

Meta Properties No Metadata available

#Refuel

Type: refuel This event is triggered when the truck is refueled.

Meta Properties

Property	Type	Description
amount	`int`	The fee amount in Euros or Dollars

#Teleport

Type: teleport This event is triggered when a teleport is detected.

Meta Properties

Property	Type	Description
from_x	`float`	The original location in-game on the X-Axis.
from_y	`float`	The original location in-game on the Y-Axis.
from_z	`float`	The original location in-game on the Z-Axis.
to_x	`float`	The new location in-game on the X-Axis.
to_y	`float`	The new location in-game on the Y-Axis.
to_z	`float`	The new location in-game on the Z-Axis.

#Speeding

Type: speeding This event is triggered when a driver is detected speeding.

Meta Properties

Property	Type	Description
speed_limit	`int`	In game limit in km/h
speed	`float`	In game limit in km/h
from_x	`float`	The original location in-game on the X-Axis.
from_y	`float`	The original location in-game on the Y-Axis.
from_z	`float`	The original location in-game on the Z-Axis.
to_x	`float`	The new location in-game on the X-Axis.
to_y	`float`	The new location in-game on the Y-Axis.
to_z	`float`	The new location in-game on the Z-Axis.