API docs by Redocly

Receive My Signals API (1.0)

Download OpenAPI specification:

Create a signal request

Create a new signal request. If a signal you own or that is shared with you is received by VEROO, and a matching signal request exists, then the signal is forwarded to your webhook.

Authorizations:
OAuth2
Request Body schema: application/json
validFrom
string <date-time>

The time at which you want to start receiving signals. If undefined, you will receive signals from now on.

validTo
string <date-time>

The time at which you want to stop receiving signals. If undefined, you will receive signals indefinitely.

licensePlate
required
string^[^ -]+$

The license plate of the truck whose signals you want to receive.

Responses

Request samples

Content type
application/json
{
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "licensePlate": "WU764GB"
}

Response samples

Content type
application/json
{
  • "signalRequestId": "31a25617-4666-4c4f-8e8f-03014eb9803e",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "licensePlate": "WU764GB",
  • "isCancelled": true
}

Get all signal requests

Retrieves all signal requests.

Authorizations:
OAuth2
query Parameters
page
string >= 1
Default: 1

The page of signal requests you want to retrieve.

pageSize
string >= 1
Default: 20

The number of signal requests per page.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "signalRequests": [
    ]
}

Cancel a signal request

Cancels a signal request. After cancelling a signal request, no more signals will be sent to you because of it.

Authorizations:
OAuth2
path Parameters
signalRequestId
required
string <uuid>

The id of the signal request to cancel.

Responses

Get a signal request

Retrieves a single signal request.

Authorizations:
OAuth2
path Parameters
signalRequestId
required
string <uuid>

The id of the signal request to get.

Responses

Response samples

Content type
application/json
{
  • "signalRequestId": "31a25617-4666-4c4f-8e8f-03014eb9803e",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "licensePlate": "WU764GB",
  • "isCancelled": true
}