API explorer
Fleet Management API Beta

Sections

Theme switcher

Search for Webhook Subscriptions.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Query Parameters

statusstring

Filter subscriptions by their status.

Enum values:
ENABLEDPENDINGDISABLED
domainstring

The domain of subscription.

Enum values:
AUTHORIZATIONDRIVERCARDVEHICLE
active_onstring

Filter subscriptions that are active on the given date (i.e. start date is on/before this date and end date is null or after this date).

callback_urlstring

The callback url of subscription.

Min length
1
Pattern
^https?://.+
pageinteger

If a query returns multiple pages (total records/size) you can use this value to select a specific page to return. Defaults to zero.

Default value
0
sizeinteger

Number of records per page.

Minimum
1
Maximum
1000
Default value
25
sortstring

Sorting criteria in the format: property asc|desc. Default sort order is ascending.

Default value
start_date

Response

200
Object

List of Webhook Subscriptions matching the search params.

Response Attributes

itemsarray

Show child attributes

nextobject

Show child attributes

notestring

Warning or informational note about the response if any.

prevobject

Show child attributes

total_countinteger

Total number of items.

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?