Skip to main content

Akoya
Documentation

Send sandbox test event

GET

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

Validate that your server can handle incoming webhook payloads from Akoya.

Path Parameters

  1. version*

    string

    version of endpoint

Body Params

  1. id*

    string

    A valid sandbox notification subscription ID. The triggered test event will be pushed to the callback URL associated with this subscription.

Responses

  1. 200

    OK

    Response Body

      notificationId

      string

      sentOn

      string

      subscriber

      object

          name

          string

          type

          string

          registry

          string

          registeredEntityId

          string

      publisher

      object

          name

          string

          type

          string

          registry

          string

          registeredEntityId

          string

      category

      string

      type

      string

      notificationPayload

      object

          id

          string

          idType

          string

          customFields

          array of objects

            object

              name

              string

              value

              string

      url

      object

          href

          string

          action

          string

  2. 400

    Input sent by client does not satisfy API specification

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  3. 401

    Unauthorized to create a notification subscription

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  4. 405

    Method Not Allowed

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  5. 429

    Too Many Requests

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  6. 500

    Catch all exception where request was not processed due to an internal outage/issue. Consider other more specific errors before using this error

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  7. 501

    Error when FdxVersion in Header is not one of those implemented at backend

    Response Body

      code

      string

      message

      string

      debugMessage

      string

  8. 503

    System is down for maintenance

    Response Body

      code

      string

      message

      string

      debugMessage

      string

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"accept": "application/json"
	},
	"body": {
		"application/json": {
			"id": ""
		}
	}
}};
fetch('https://sandbox-api.akoya.com/notifications//test', options)
  .then(response => response.json())
  .catch(err => console.error(err));
Maintenance notification detailsGet Consent Grant