subscriptionIdstring(uuid)required
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
Get Subscription
Get a subscription by ID.
📝 Important Notes
- Returns the subscription details including webhook URL and subscription rules.
- The response will include an
ETagheader, which should be used for theIf-Matchheader in subsequent updates.
get
https://event-api.centraldispatch.com/subscriptions/id/{subscriptionId}
Path Parameters
Headers
Acceptstringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Response
application/json
Response
application/json
OK. Successful request.
SubscriptionResponse
Details of a subscription.
hrefstring
The fully qualified URL of the subscription.
Example:https://event-api.centraldispatch.com/subscriptions/id/50b2863f-c75e-45cb-8d50-b5a975d67865
subscriptionIdstring(uuid)
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
callbackUrlstring
A valid URL that you own, which will be used to receive event notifications from the Central Dispatch Event service.
Example:https://abc-trcking.net/webhook
isEnabledboolean
Indicates whether the subscription is currently active.
Example:true
subscriptionRulesobject
Details of subscription rules.
Show Child Parameters
get/subscriptions/id/{subscriptionId}
Authentication
Path Parameters
Headers
application/json
Update Subscription
Update a subscription.
📝 Important Notes
- Requires the full subscription payload for updates.
- Must include all existing event types plus any new ones.
- The
If-Matchheader is required and its value can be found in theETagresponse header of the resource’s GET by ID endpoint.
put
https://event-api.centraldispatch.com/subscriptions/id/{subscriptionId}
Path Parameters
subscriptionIdstring(uuid)required
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
Headers
If-Matchintegerrequired
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
Content-Typestringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Body
application/json
Body
application/json
UpdateSubscriptionRequest
UpdateSubscriptionRequest
Details of update subscription request.
callbackUrlstringrequired
A valid URL that you own, which will be used to receive event notifications from the Central Dispatch Event service.
Example:https://abc-trcking.net/webhook
subscriptionRulesobjectrequired
Details of subscription rules.
Show Child Parameters
isEnabledboolean
Indicates whether the subscription is currently active.
Default:false
Example:true
Response
Response
No Content. Successful request.
put/subscriptions/id/{subscriptionId}
Authentication
Path Parameters
Headers
Body
{
"callbackUrl": "https://abc-trcking.net/webhook",
"subscriptionRules": {
"marketplaces": [
"10000"
],
"eventTypes": [
"DispatchCreated",
"DispatchUpdated",
"DispatchAccepted",
"DispatchVehiclePickedup",
"DispatchVehicleDelivered"
]
},
"isEnabled": true
}
Renew Subscription
Renew your subscription API key.
📝 Important Notes
- Use this endpoint if your API key was lost or compromised.
- The new
Api-Keywill be returned in the response headers. - The old API key will be immediately invalidated.
- All future events will use the new API key for authentication.
- The
If-Matchheader is required and its value can be found in theETagresponse header of the resource’s GET by ID endpoint.
post
https://event-api.centraldispatch.com/subscriptions/id/{subscriptionId}/renew
Path Parameters
subscriptionIdstring(uuid)required
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
Headers
If-Matchintegerrequired
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
Content-Typestringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Response
Response
No Content. Successful request.
post/subscriptions/id/{subscriptionId}/renew
Authentication
Path Parameters
Headers
Get My Subscriptions
Get all subscriptions associated with the authenticated customer.
📝 Important Notes
- Returns all active subscriptions for the customer in the Bearer token.
- Includes webhook URLs and subscription rules for each subscription.
get
https://event-api.centraldispatch.com/subscriptions/mine
Headers
Acceptstringrequired
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
Response
application/json
Response
application/json
OK. Successful request.
SubscriptionCollection
Details of subscriptions.
hrefstring
The URL used to query the current collection of the resource.
Example:https://event-api.centraldispatch.com/subscriptions/mine
countinteger(int32)
The total count of resources in the collection.
Example:23
itemsarray[object]
Details of a subscription.
Show Child Parameters
get/subscriptions/mine
Authentication
Headers
application/json
EmptyResponse
objectNo response.