Subscriptions API Specification

Open API 2.0 Specification

SubscriptionsApi

Method / Description	HTTP request
createSubscription Create a new Subscription object.	POST /v2/settings/subscriptions
deleteSubscription Delete an existing Subscription object.	DELETE /v2/settings/subscriptions/{id}
getEventTypes Gets a paged list of EventType objects.	GET /v2/settings/subscriptions/eventTypes
getSubscription Gets a single Subscription object.	GET /v2/settings/subscriptions/{id}
getSubscriptionHistory Gets a paged list of SubscriptionHistory objects. Subscription history is available for the previous 30 days.	GET /v2/settings/subscriptions/{id}/history
getSubscriptionTest Request a test hook be sent to the specified Subscription.	GET /v2/settings/subscriptions/{id}/test
getSubscriptions Gets a paged list of Subscription objects.	GET /v2/settings/subscriptions
updateSubscription Update an existing Subscription object.	PUT /v2/settings/subscriptions/{id}

Documentation for Models

• apiResponse
• createSubscriptionRequest
• errorResponse
• eventType
• pagedApiResponse
• pagedEventTypesResponse
• pagedSubscriptionHistoryResponse
• pagedSubscriptionResponse
• responseMessage
• responseStatus
• singleSubscriptionResponse
• subscription
• subscriptionHistory
• subscriptionHistory_request
• subscriptionHistory_response
• subscriptionSecurity
• updateSubscriptionRequest
• validationFailure

Documentation for Authorization

All endpoints do not require authorization.