Search
K
Event API

SubscriptionRequest

object

Details of a subscription.

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
Example
{
  "callbackUrl": "https://abc-trcking.net/webhook",
  "subscriptionRules": {
    "marketplaces": [
      "10000"
    ],
    "eventTypes": [
      "DispatchCreated",
      "DispatchUpdated",
      "DispatchAccepted"
    ]
  }
}

SubscriptionResponse

object

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
Example
{
  "href": "https://event-api.centraldispatch.com/subscriptions/id/50b2863f-c75e-45cb-8d50-b5a975d67865",
  "subscriptionId": "50b2863f-c75e-45cb-8d50-b5a975d67865",
  "callbackUrl": "https://abc-trcking.net/webhook",
  "isEnabled": true,
  "subscriptionRules": {
    "marketplaces": [
      "10000"
    ],
    "eventTypes": [
      "DispatchCreated",
      "DispatchUpdated",
      "DispatchAccepted"
    ]
  }
}

SubscriptionRules

object

Details of subscription rules.

marketplacesarray[string]required

A collection of Marketplaces to which the subscription applies. The caller must have access to all listed Marketplaces.

Example:10000

eventTypesarray[string]required

A collection of event types. Use the Get Event Types endpoint to retrieve valid values.

Example:DispatchCreated, DispatchUpdated, DispatchAccepted

Example
{
  "marketplaces": [
    "10000"
  ],
  "eventTypes": [
    "DispatchCreated",
    "DispatchUpdated",
    "DispatchAccepted"
  ]
}

UpdateSubscriptionRequest

object

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

Example
{
  "callbackUrl": "https://abc-trcking.net/webhook",
  "subscriptionRules": {
    "marketplaces": [
      "10000"
    ],
    "eventTypes": [
      "DispatchCreated",
      "DispatchUpdated",
      "DispatchAccepted"
    ]
  },
  "isEnabled": true
}