Fleet Management API Beta

Sections

Theme switcher

Create a new Webhook Subscription.

Header Parameters

Authorizationstring

Body Parameters

accountsarray

Optional list of account IDs to scope the subscription to. When provided and non-empty, notifications are sent only for events on these accounts or their descendants. When omitted or empty on create, the subscription defaults to the caller's root account(s). When omitted or empty on update, existing accounts are preserved. Accounts must belong to the caller's root account hierarchy.

Max items
100

Show child attributes

callback_urlstring Required

Subscription callback url. Must be a valid HTTP or HTTPS URL.

Min length
1
Pattern
^https?://.+
domainstring Required

Subscription Domain.

Enum values:
AUTHORIZATIONDRIVERCARDVEHICLE
end_datestring

Subscription End Date. For search operations: Filter subscriptions that are active on or before this date (i.e., whose start date is on/before this date).

start_datestring Required

Subscription Start Date. For search operations: Filter subscriptions that are active on or after this date (i.e., whose end date is null or on/after this date).

Response

201
Object

201 (Created)

Response Attributes

_linksobject

HATEOAS links to subscription-related resources

Show child attributes

accountsarray

Optional list of account IDs to scope the subscription to. When provided and non-empty, notifications are sent only for events on these accounts or their descendants. When omitted or empty on create, the subscription defaults to the caller's root account(s). When omitted or empty on update, existing accounts are preserved. Accounts must belong to the caller's root account hierarchy.

Max items
100

Show child attributes

callback_urlstring

Subscription callback url. Must be a valid HTTP or HTTPS URL.

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

Subscription Domain.

Enum values:
AUTHORIZATIONDRIVERCARDVEHICLE
end_datestring

Subscription End Date. For search operations: Filter subscriptions that are active on or before this date (i.e., whose start date is on/before this date).

idinteger

Subscription Id.

secret_tokenstring

Secret token for webhook HMAC signature. Only provided on the initial creation of the subscription.

start_datestring

Subscription Start Date. For search operations: Filter subscriptions that are active on or after this date (i.e., whose end date is null or on/after this date).

statusstring

Subscription status

Enum values:
ENABLEDPENDINGDISABLED
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?

POST

/

Select
1

Response

Was this section helpful?