Veroo TBS Incentivized Activities (0.9.0)

Download OpenAPI specification:

This API allows you to reward truckers for your defined actions

Activities

Creates a new activity

Creates a new activity for a given truck driver (truckerId property)

Authorizations:
VerooApiKeyAuth
Request Body schema: application/json
activityKey
required
string

The classifier of what kind of activity should be rewarded (these can be specified by the customer himself)

truckerId
required
string <tid> ^\d{3}-\d{8}-\d$

The trucker who should be rewarded for performing this activity, referenced by the corresponding TruckerID

object
object

Responses

Request samples

Content type
application/json
{
  • "activityKey": "DOC_UPLOAD",
  • "truckerId": "234-00000012-6",
  • "job": {
    },
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "activityId": "9bf74960-1b21-4b26-b7a2-412852de962",
  • "activityKey": "DOC_UPLOAD",
  • "timestamp": "2020-07-22T14:28:02Z",
  • "reward": 48
}

Schemas

Returns the bonus schema

Returns all bonus schemas

Authorizations:
VerooApiKeyAuth

Responses

Response samples

Content type
application/json
"{\n \"items\": [\n {\n \"id\": \"9d8595b9-2259-4ab8-a610-6de0f97383d4\"\n \"version\": 1\n \"multiplierList\": [\n {\n \"min\": 351,\n \"multiplier\": 2\n },\n {\n \"min\": 701,\n \"multiplier\": 3\n }\n ],\n \"activityRules\": {\n \"DOC_UPLOAD\": {\n \"points\": 20,\n \"multipliable\": true,\n \"jobRequired\": true\n },\n \"LOAD_SECURITY\": {\n \"points\": 20,\n \"multipliable\": true,\n \"jobRequired\": true\n },\n \"GPS_ACTIVATION\": {\n \"points\": 15,\n \"multipliable\": false,\n \"jobRequired\": true\n },\n \"TRAILER_CHECK\": {\n \"points\": 20,\n \"multipliable\": true,\n \"jobRequired\": true\n },\n \"PROFILE_COMPLETION\": {\n \"points\": 100,\n \"multipliable\": false,\n \"jobRequired\": false\n } \n }\n }\n ]\n}\n"