Skip to main content

Akoya
Documentation

List notification subscriptions

GET

https://sandbox-api.akoya.com/notifications/{version}/subscriptions

List your notification subscriptions.

🛑 The service token should be used as the bearer token with this call.


Path Parameters

  1. version*

    stringdefault: v1

    version of endpoint.

Body Params

  1. category*

    string

    Category of Notification

  2. type*

    string

    Type of Notification

  3. callbackUrl*

    string

    The URL to receive webhooks from Akoya. Must be HTTPS.

    Example: https://abc.com/notification

  4. effectiveDate

    string

    Effective date of notification

    Example: 2021-07-15

  5. callbackEmail

    string

    Optional. Captured for future implementation, which will be in an upcoming release.


Responses

  1. 200

    OK

    Response Body

      notificationSubscriptions

      array of objects

          category

          Category of notification

            string

          type

          Type of notification

            string

          callbackUrl

          string

          The URL to receive webhooks from Akoya. Must be HTTPS.

          effectiveDate

          string

          Effective date of notification

          callbackEmail

          string

          Optional. Captured for future implementation, which will be in an upcoming release.

          subscriptionId

          string

          id

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"accept": "application/json"
	},
	"body": {
		"application/json": {
			"category": "MAINTENANCE",
			"type": "SERVICE",
			"callbackUrl": ""
		}
	}
}};
fetch('https://sandbox-api.akoya.com/notifications/v1/subscriptions', options)
  .then(response => response.json())
  .catch(err => console.error(err));