---
title: "Event API"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-event-api-1-0-0/versions/c1db9b9c-04c4-43e9-9e9c-fe74c2ca0f60"
---

# Event API

OpenAPI specification document.

```json
{"openapi":"3.0.1","info":{"title":"Event API","description":"\nCentral Dispatch's Event API allows customers to receive event notifications. It offers a comprehensive list of events along with detailed descriptions, enabling users to subscribe to events of interest. Additionally, the API provides functionality to search and retrieve historical customer events.\n\n#### 📝 Important Notes\n- Event Notification does not guarantee order of event delivery, nor does it guarantee a single instance of event delivery. The end partner should support these eventualities. The `eventId` key in the event payload can be used to identify duplicate event deliveries.\n- The subscription response returns an Api-Token header that should be stored by the partner. This token will be sent with every event notification, and the partner should compare the Api-Token sent with each event against their own cached version to validate event authenticity. This is the only authentication that should be implemented for this endpoint.\n- Events and status of the events are presisted. If an eventing user is unable to receive events for some time, they can work with the `Search Events` endpoint.\n- The customer must provide an endpoint that CD event notification service can call to push the message.\n- The `body` of the events delivered to the customer’s webhook (supplied through subscription) will vary based on event type that is being delivered. \n","contact":{"email":"datasyndicationsupport@centraldispatch.com"},"version":"1.0.0"},"servers":[{"url":"https://event-api.centraldispatch.com","description":"Production server"}],"paths":{"/event-types":{"get":{"tags":["Event"],"summary":"Get Event Types","description":"\nGet a collection of all events currently offered.\nReturns a list of event types and descriptions, enabling users to create subscriptions for events of interest.","operationId":"getEventTypes","parameters":[{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypeCollection"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/integrator-events":{"get":{"tags":["Event"],"summary":"Search Events","description":"Search for published events.","operationId":"getSearchIntegratorEvents","parameters":[{"name":"gt(createdOn,<startDateTime>)","in":"query","description":"Search for events with created date greater than value, in UTC/ISO 8601 format.","schema":{"type":"string"},"example":"gt(createdOn,2024-01-19)"},{"name":"lt(createdOn,<endDateTime>)","in":"query","description":"Search for events with created date less than value, in UTC/ISO 8601 format.","schema":{"type":"string"},"example":"lt(createdOn,2024-02-13)"},{"name":"eq(subscriptionId,<subscriptionId>)","in":"query","description":"Search for events with subscription ID equal to value (GUID).","schema":{"type":"string"},"example":"eq(subscriptionId,50b2863f-c75e-45cb-8d50-b5a975d67865)"},{"name":"eq(eventId,<eventId>)","in":"query","description":"Search for events with event ID equal to value (GUID).","schema":{"type":"string"},"example":"eq(eventId,eec2b82e-29b1-47c3-a391-6da6cce37d7d)"},{"name":"eq(publishStatus,<publishStatus>)","in":"query","description":"Search for events with publish status equal to value. Allowed values: `SUCCESS`, `FAILED`.","schema":{"type":"string"},"example":"eq(publishStatus,SUCCESS)"},{"name":"eq(eventType,<eventType>)","in":"query","description":"Search for events with event type equal to value. Use the `Get Event Types` endpoint to retrieve valid values.","schema":{"type":"string"},"example":"eq(eventType,DispatchCreated)"},{"name":"limit(startingPoint,numberOfResults)","in":"query","description":"The maximum number of items to be returned in the response.\n - `startingPoint` is 1-based integer, default 1.\n - `numberOfResults` is an integer, default 500, maximum 500.","schema":{"type":"string"},"example":"limit(1,10)"},{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchIntegratorEventCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Invalid start or limit values.\n - Invalid filter parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/subscriptions":{"post":{"tags":["Subscription"],"summary":"Create Subscriptions","description":"\nCreate new event subscriptions.\n\n#### 📝 Important Notes\n- Creates a webhook subscription for specified event types.\n- The response will be empty but includes three important headers.\n - The `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.\n - The response will contain a `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.\n - The response will include an `ETag` header, which should be used for the `If-Match` header in subsequent updates.","operationId":"postCreateSubscription","parameters":[{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"requestBody":{"description":"`SubscriptionRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionRequest"},"examples":{"sample":{"value":{"callbackUrl":"https://abc-trcking.net/webhook","subscriptionRules":{"marketplaces":["10000"],"eventTypes":["DispatchCreated","DispatchUpdated","DispatchAccepted"]}}}}}}},"responses":{"201":{"description":"Created. Successful request.","headers":{"Location":{"description":"Contains the fully qualified URL of the newly created or updated resource. The final segment of the URL will equal the ID of the resource.","schema":{"type":"string"},"example":"8675309"},"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Api-Key":{"description":"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.","schema":{"type":"string"},"example":"True"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing required fields.\n - Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - Duplicate subscription attempt.\n - Subscription with same callback URL and event type already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - Invalid callback URL format.\n - Missing required fields in subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/subscriptions/id/{subscriptionId}":{"get":{"tags":["Subscription"],"summary":"Get Subscription","description":"\nGet a subscription by ID.\n\n#### 📝 Important Notes\n- Returns the subscription details including webhook URL and subscription rules.\n- The response will include an `ETag` header, which should be used for the `If-Match` header in subsequent updates.","operationId":"getSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"The ID of the subscription.","required":true,"schema":{"type":"string","format":"uuid"},"example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Subscription not found.\n - Invalid `subscriptionId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]},"put":{"tags":["Subscription"],"summary":"Update Subscription","description":"\nUpdate a subscription.\n\n#### 📝 Important Notes\n- Requires the full subscription payload for updates.\n- Must include all existing event types plus any new ones.\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.","operationId":"putSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"The ID of the subscription.","required":true,"schema":{"type":"string","format":"uuid"},"example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},{"name":"If-Match","in":"header","description":"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.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"requestBody":{"description":"`UpdateSubscriptionRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},"examples":{"sample":{"value":{"callbackUrl":"https://abc-trcking.net/webhook","subscriptionRules":{"marketplaces":["10000"],"eventTypes":["DispatchCreated","DispatchUpdated","DispatchAccepted","DispatchVehiclePickedup","DispatchVehicleDelivered"]},"isEnabled":true}}}}}},"responses":{"204":{"description":"No Content. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"Location":{"description":"Contains the fully qualified URL of the newly created or updated resource. The final segment of the URL will equal the ID of the resource.","schema":{"type":"string"},"example":"8675309"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing `If-Match` header (required for updates).\n - Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Subscription not found.\n - Invalid `subscriptionId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"412":{"description":"Precondition Failed\n\n**Scenarios:**\n\n - `If-Match` header doesn't match current `ETag`.\n - Concurrent modification detected.\n - Resource modified by another request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - Invalid callback URL in subscription.\n - Attempting to modify immutable fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/subscriptions/id/{subscriptionId}/renew":{"post":{"tags":["Subscription"],"summary":"Renew Subscription","description":"\nRenew your subscription API key.\n\n#### 📝 Important Notes\n- Use this endpoint if your API key was lost or compromised.\n- The new `Api-Key` will be returned in the response headers.\n- The old API key will be immediately invalidated.\n- All future events will use the new API key for authentication.\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.","operationId":"postRenewSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"The ID of the subscription.","required":true,"schema":{"type":"string","format":"uuid"},"example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},{"name":"If-Match","in":"header","description":"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.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"204":{"description":"No Content. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"Api-Key":{"description":"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.","schema":{"type":"string"},"example":"True"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing `If-Match` header (required for renewal).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Subscription not found.\n - Invalid `subscriptionId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}}},"412":{"description":"Precondition Failed\n\n**Scenarios:**\n\n - `If-Match` header doesn't match current `ETag`.\n - Concurrent modification detected.\n - Resource modified by another request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/subscriptions/id/{subscriptionId}/reactivate":{"post":{"tags":["Subscription"],"summary":"Reactivate Subscription","description":"\nRe-enables a subscription that has been deactivated. Sets the subscription status to active so that event notifications resume delivery to the registered callback URL. The existing API token is preserved — the partner does not need to update their cached token after reactivation.\n\n#### 📝 Important Notes\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.","operationId":"postReactivateSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"The ID of the subscription.","required":true,"schema":{"type":"string","format":"uuid"},"example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},{"name":"If-Match","in":"header","description":"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.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"204":{"description":"No Content. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"Api-Key":{"description":"The subscription's API token (unchanged). Store this and validate it against tokens sent with each event notification.","schema":{"type":"string"},"example":"True"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing `If-Match` header (required for reactivation).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Subscription not found.\n - Invalid `subscriptionId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"412":{"description":"Precondition Failed\n\n**Scenarios:**\n\n - `If-Match` header doesn't match current `ETag`.\n - Concurrent modification detected.\n - Resource modified by another request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/subscriptions/mine":{"get":{"tags":["Subscription"],"summary":"Get My Subscriptions","description":"\nGet all subscriptions associated with the authenticated customer.\n\n#### 📝 Important Notes\n- Returns all active subscriptions for the customer in the Bearer token.\n- Includes webhook URLs and subscription rules for each subscription.","operationId":"getSubscriptionsMine","parameters":[{"name":"Accept","in":"header","description":"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`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v1+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v1; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCollection"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"EmptyResponse":{"type":"object","description":"No response."},"Error":{"type":"object","properties":{"code":{"type":"string","description":"The code used for the issue.","nullable":true,"example":"resource.issue_type"},"message":{"type":"string","description":"A detailed message.","nullable":true,"example":"The issue happened because something is wrong."},"property":{"type":"string","description":"The property to which the issue is associated.","nullable":true,"example":"person"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional properties related to the issue.","nullable":true,"example":{"firstName":"D0nn@","lastName":"Sm!th"}}},"description":"Details of an error or issue."},"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A collection of errors.","nullable":true}},"description":"An error occurred, and the request could not be completed."},"EventTypeCollection":{"required":["href","count","items"],"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://event-api.centraldispatch.com/event-types"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeResponse"},"description":"A collection of records."}},"description":"Details of the event types."},"EventTypeResponse":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event.","nullable":true,"example":"DispatchCreated"},"description":{"type":"string","description":"The description of the event type.","nullable":true,"example":"A dispatch has been created"}},"description":"Details of an event type."},"IntegratorEventResponse":{"type":"object","properties":{"eventId":{"type":"string","description":"The ID of the event.","format":"uuid","example":"eec2b82e-29b1-47c3-a391-6da6cce37d7d"},"eventType":{"type":"string","description":"The type of the event.","example":"DispatchCreated"},"topic":{"type":"string","description":"The versioned group of events to which the event belongs.","example":"logistics.cd.dispatch"},"topicVersion":{"type":"string","description":"The version of the topic.","example":"1"},"timeStamp":{"type":"string","description":"The timestamp at the time of submission of the event to the event service, in UTC/ISO 8601 format.","format":"date-time","example":"2023-02-28T21:55:38Z"},"environment":{"type":"string","description":"The environment of the event e.g. production.","example":"Production"},"partition":{"type":"string","description":"The data partition for which the data within the event belongs (e.g. 'production-resources' or 'non-production-resources').","example":"production-resources"},"correlationId":{"type":"string","description":"The correlation ID of the event used for logging and tracking.","format":"uuid","example":"c0b87c96-1bfb-43f4-956d-c4283ecaab7c"},"headers":{"type":"object","description":"The headers of the event.","nullable":true,"example":{"messageId":"157a16f0-503d-4256-ba60-a4876e8eb9bb","subscriptionId":"50b2863f-c75e-45cb-8d50-b5a975d67865","marketplaceIds":["10000"]}},"body":{"description":"The body contains a JSON object that is the event contents.","example":{"dispatchId":"d159acc0-e89b-12d3-a456-426614174000","dispatchVehicleIds":["b331c130-e89b-12d3-a456-426614174000"]}}},"description":"Details of an event.","nullable":true},"SearchEventResponse":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"The ID of the subscription.","format":"uuid","example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},"publishStatus":{"type":"string","description":"The publish status of the event.","example":"SUCCESS"},"createdOn":{"type":"string","description":"The creation date and time of the integrator event record, in UTC/ISO 8601 format.","format":"date-time","example":"2024-10-25T19:06:56.85Z"},"eventData":{"$ref":"#/components/schemas/IntegratorEventResponse"}},"description":"Details of an event."},"SearchIntegratorEventCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://event-api.centraldispatch.com/integrator-events?limit(5,1)"},"previous":{"type":"string","description":"The URL to the previous page of the collection, if available.","nullable":true,"example":"https://event-api.centraldispatch.com/integrator-events?limit(4,1)"},"first":{"type":"string","description":"The URL to the first page of the collection.","nullable":true,"example":"https://event-api.centraldispatch.com/integrator-events?limit(1,1)"},"next":{"type":"string","description":"The URL to the next page of the collection, if available.","nullable":true,"example":"https://event-api.centraldispatch.com/integrator-events?limit(6,1)"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23},"limit":{"type":"integer","description":"The maximum number of items to be returned in the response.","format":"int32","example":1},"items":{"type":"array","items":{"$ref":"#/components/schemas/SearchEventResponse"},"description":"A collection of records."}},"description":"Details of search event."},"SubscriptionCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://event-api.centraldispatch.com/subscriptions/mine"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23},"items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionResponse"},"description":"A collection of records."}},"description":"Details of subscriptions."},"SubscriptionRequest":{"required":["callbackUrl","subscriptionRules"],"type":"object","properties":{"callbackUrl":{"type":"string","description":"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"},"subscriptionRules":{"$ref":"#/components/schemas/SubscriptionRules"}},"description":"Details of a subscription."},"SubscriptionResponse":{"type":"object","properties":{"href":{"type":"string","description":"The fully qualified URL of the subscription.","example":"https://event-api.centraldispatch.com/subscriptions/id/50b2863f-c75e-45cb-8d50-b5a975d67865"},"subscriptionId":{"type":"string","description":"The ID of the subscription.","format":"uuid","example":"50b2863f-c75e-45cb-8d50-b5a975d67865"},"callbackUrl":{"type":"string","description":"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"},"isEnabled":{"type":"boolean","description":"Indicates whether the subscription is currently active.","example":true},"subscriptionRules":{"$ref":"#/components/schemas/SubscriptionRules"}},"description":"Details of a subscription."},"SubscriptionRules":{"required":["marketplaces","eventTypes"],"type":"object","properties":{"marketplaces":{"type":"array","items":{"type":"string"},"description":"A collection of Marketplaces to which the subscription applies. The caller must have access to all listed Marketplaces.","example":["10000"]},"eventTypes":{"type":"array","items":{"type":"string"},"description":"A collection of event types. Use the `Get Event Types` endpoint to retrieve valid values.","example":["DispatchCreated","DispatchUpdated","DispatchAccepted"]}},"description":"Details of subscription rules."},"UpdateSubscriptionRequest":{"required":["callbackUrl","subscriptionRules"],"type":"object","properties":{"callbackUrl":{"type":"string","description":"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"},"subscriptionRules":{"$ref":"#/components/schemas/SubscriptionRules"},"isEnabled":{"type":"boolean","description":"Indicates whether the subscription is currently active.","default":false,"example":true}},"description":"Details of update subscription request."}},"securitySchemes":{"Bearer":{"type":"http","scheme":"Bearer"}}},"tags":[{"name":"Event"},{"name":"Subscription"}]}
```