Search
K
Event API

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

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
  
curl --request GET \
  --url https://event-api.centraldispatch.com/subscriptions/mine \
  --header 'Accept: application/vnd.coxauto.v1+json' \
  --header 'Authorization: Bearer ' \
  --header 'Content-Type: application/json'
application/json
{
  "href": "https://event-api.centraldispatch.com/subscriptions/mine",
  "count": 23,
  "items": [
    {
      "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"
        ]
      }
    }
  ]
}

EmptyResponse

object

No response.

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

messagestring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example
{
  "code": "resource.issue_type",
  "message": "The issue happened because something is wrong.",
  "property": "person",
  "properties": {
    "firstName": "D0nn@",
    "lastName": "Sm!th"
  }
}

Errors

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example
{
  "errors": [
    {
      "code": "resource.issue_type",
      "message": "The issue happened because something is wrong.",
      "property": "person",
      "properties": {
        "firstName": "D0nn@",
        "lastName": "Sm!th"
      }
    }
  ]
}

EventTypeCollection

object

Details of the event types.

hrefstringrequired

The URL used to query the current collection of the resource.

Example:https://event-api.centraldispatch.com/event-types

countinteger(int32)required

The total count of resources in the collection.

Example:1

itemsarray[object]required

Details of an event type.

Show Child Parameters
Example
{
  "href": "https://event-api.centraldispatch.com/event-types",
  "count": 1,
  "items": [
    {
      "eventType": "DispatchCreated",
      "description": "A dispatch has been created"
    }
  ]
}