Get a collection of all events currently offered.
Returns a list of event types and descriptions, enabling users to create subscriptions for events of interest.
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
OK. Successful request.
Details of the event types.
The URL used to query the current collection of the resource.
Example:https://event-api.centraldispatch.com/event-types
The total count of resources in the collection.
Example:1
Details of an event type.
Search for published events.
Search for events with created date greater than value, in UTC/ISO 8601 format.
Example:gt(createdOn,2024-01-19)
Search for events with created date less than value, in UTC/ISO 8601 format.
Example:lt(createdOn,2024-02-13)
Search for events with subscription ID equal to value (GUID).
Example:eq(subscriptionId,50b2863f-c75e-45cb-8d50-b5a975d67865)
Search for events with event ID equal to value (GUID).
Example:eq(eventId,eec2b82e-29b1-47c3-a391-6da6cce37d7d)
Search for events with publish status equal to value. Allowed values: SUCCESS, FAILED.
Example:eq(publishStatus,SUCCESS)
Search for events with event type equal to value. Use the Get Event Types endpoint to retrieve valid values.
Example:eq(eventType,DispatchCreated)
The maximum number of items to be returned in the response.
startingPoint is 1-based integer, default 1.numberOfResults is an integer, default 500, maximum 500.Example:limit(1,10)
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
OK. Successful request.
Details of search event.
The URL used to query the current collection of the resource.
Example:https://event-api.centraldispatch.com/integrator-events?limit(5,1)
The URL to the previous page of the collection, if available.
Example:https://event-api.centraldispatch.com/integrator-events?limit(4,1)
The URL to the first page of the collection.
Example:https://event-api.centraldispatch.com/integrator-events?limit(1,1)
The URL to the next page of the collection, if available.
Example:https://event-api.centraldispatch.com/integrator-events?limit(6,1)
The total count of resources in the collection.
Example:23
The maximum number of items to be returned in the response.
Example:1
Details of an event.
Create new event subscriptions.
Api-Key header value should be stored by the caller and used to authenticate all incoming events from Central Dispatch. The value will be contained in the Api-Token header in all events delivered as part of this subscription.Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.ETag header, which should be used for the If-Match header in subsequent updates.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
SubscriptionRequest
Details of a subscription.
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
Details of subscription rules.
Created. Successful request.
Get a subscription by ID.
ETag header, which should be used for the If-Match header in subsequent updates.The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
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
OK. Successful request.
Details of a subscription.
The fully qualified URL of the subscription.
Example:https://event-api.centraldispatch.com/subscriptions/id/50b2863f-c75e-45cb-8d50-b5a975d67865
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
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
Indicates whether the subscription is currently active.
Example:true
Details of subscription rules.
Update a subscription.
If-Match header is required and its value can be found in the ETag response header of the resource’s GET by ID endpoint.The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
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
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
UpdateSubscriptionRequest
Details of update subscription request.
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
Details of subscription rules.
Indicates whether the subscription is currently active.
Default:false
Example:true
No Content. Successful request.