Get a Webhook Subscription.
Authentication
Standard HTTP Bearer token. Enter the 'access_token' value.
Header Parameters
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...
Path Parameters
Subscription Id.
Response
200 (Ok)
Response Attributes
HATEOAS links to subscription-related resources
Show child attributes
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.
Show child attributes
Subscription callback url. Must be a valid HTTP or HTTPS URL.
Subscription Domain.
AUTHORIZATIONDRIVERCARDVEHICLESubscription 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).
Optional list of event type names to filter which events trigger notifications for this subscription. When provided and non-empty, only events matching one of the listed types will be sent. When omitted or empty, all events for the domain will be sent. Use the GET /webhooks/event-types endpoint to discover available event types per domain.
Show child attributes
Subscription Id.
Secret token for webhook HMAC signature. Only provided on the initial creation of the subscription.
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).
Subscription status
ENABLEDPENDINGDISABLED400 (Bad Request)
Response Attributes
401 (Unauthorized)
Response Attributes
404 (Not Found)
Response Attributes
500 (Internal Server Error)
Response Attributes
Response