IntegratorEventResponse
objectDetails of an event.
The ID of the event.
Example:eec2b82e-29b1-47c3-a391-6da6cce37d7d
The type of the event.
Example:DispatchCreated
The versioned group of events to which the event belongs.
Example:logistics.cd.dispatch
The version of the topic.
Example:1
The timestamp at the time of submission of the event to the event service, in UTC/ISO 8601 format.
Example:2023-02-28T21:55:38Z
The environment of the event e.g. production.
Example:Production
The data partition for which the data within the event belongs (e.g. ‘production-resources’ or ‘non-production-resources’).
Example:production-resources
The correlation ID of the event used for logging and tracking.
Example:c0b87c96-1bfb-43f4-956d-c4283ecaab7c
The headers of the event.
Example:{"messageId":"157a16f0-503d-4256-ba60-a4876e8eb9bb","subscriptionId":"50b2863f-c75e-45cb-8d50-b5a975d67865","marketplaceIds":["10000"]}
The body contains a JSON object that is the event contents.
Example:{"dispatchId":"d159acc0-e89b-12d3-a456-426614174000","dispatchVehicleIds":["b331c130-e89b-12d3-a456-426614174000"]}
SearchEventResponse
objectDetails of an event.
The ID of the subscription.
Example:50b2863f-c75e-45cb-8d50-b5a975d67865
The publish status of the event.
Example:SUCCESS
The creation date and time of the integrator event record, in UTC/ISO 8601 format.
Example:2024-10-25T19:06:56.85Z
Details of an event.
Show Child Parameters
SearchIntegratorEventCollection
objectDetails 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.
Show Child Parameters
SubscriptionCollection
objectDetails of subscriptions.
The URL used to query the current collection of the resource.
Example:https://event-api.centraldispatch.com/subscriptions/mine
The total count of resources in the collection.
Example:23
Details of a subscription.
Show Child Parameters
SubscriptionRequest
objectDetails 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.