Health

APIDescription
GET Health/Status

No documentation available.

SubscriptionTypes

Provides routes for managing SubscriptionTypes

APIDescription
DELETE SubscriptionTypes?Name={Name}

Removes a Subscription Type from the system

PUT SubscriptionTypes

Updates an existing Subscription Type

POST SubscriptionTypes

Creates a new Subscription Type

GET SubscriptionTypes

Gets all Subscription Types in the system.

GET {authenticationKey}/{version}/SubscriptionTypes/HeartBeat

No documentation available.

Subscriptions

Routes for management of Notification/Subscriptions

APIDescription
GET Subscriptions/IsSubscribed?SubscriptionKey={SubscriptionKey}&SubscriptionType={SubscriptionType}

Checks to see if a particular user is subscribed based on subscription key and message name/type.

POST Subscriptions

Creates a subscription

PUT Subscriptions

Update a subscription

DELETE Subscriptions?SubscriptionKey={SubscriptionKey}&SubscriptionType={SubscriptionType}

Removes a subscription from the system

GET Subscriptions?SubscriptionKey={SubscriptionKey}&SubscriptionType={SubscriptionType}

Retrieves a single subscription by its identifying characteristics

GET Subscriptions?SubscriptionKey={SubscriptionKey}

Gets all subscriptions matching the SubscriptionKey

GET {authenticationKey}/{version}/SubscriptionTypes/{Name}/Subscriptions

Gets all subscriptions matching the SubscriptionType.Name/>

GET {authenticationKey}/{version}/DeliveryMethods

Gets all Delivery Methods in the system.

GET {authenticationKey}/{version}/SMTPServerTypes

Gets all SMTP Server Types in the system.

GET {authenticationKey}/{version}/Subscriptions/HeartBeat

No documentation available.

Notifications

Provides a common framework for receiving and delivering notifications and notification statuses

APIDescription
GET Notifications/{ModuleKey}/{externalIdentifier}/Status/ExternalIdentifier

Returns the status of a Notification after fetching it by its external identifier

GET Notifications/{ModuleKey}/{notificationID}/Status

Returns the status of a Notification after fetching it by internal unique identifier

POST Notifications/{ModuleKey}

Creates a new Notification

GET {authenticationKey}/{version}/Notifications/HeartBeat

No documentation available.