Stage - Event API

Event API

Renew Subscription

Renew your subscription API key.

📝 Important Notes

  • Use this endpoint if your API key was lost or compromised.
  • The new Api-Key will be returned in the response headers.
  • The old API key will be immediately invalidated.
  • All future events will use the new API key for authentication.
  • 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.
post
https://event-api.centraldispatch.com/subscriptions/id/{subscriptionId}/renew

Path Parameters

subscriptionIdstring(uuid)required

The ID of the subscription.

Example:50b2863f-c75e-45cb-8d50-b5a975d67865

Headers

If-Matchintegerrequired

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

Content-Typestringrequired

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

Response

No Content. Successful request.

post/subscriptions/id/{subscriptionId}/renew
 

Reactivate Subscription

Re-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.

📝 Important Notes

  • 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.
post
https://event-api.centraldispatch.com/subscriptions/id/{subscriptionId}/reactivate

Path Parameters

subscriptionIdstring(uuid)required

The ID of the subscription.

Example:50b2863f-c75e-45cb-8d50-b5a975d67865

Headers

If-Matchintegerrequired

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

Content-Typestringrequired

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

Response

No Content. Successful request.

post/subscriptions/id/{subscriptionId}/reactivate
 

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
 
application/json

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