When you get a notification

If an event occurs, you will receive a notification that an event with the category and type of your subscription has occurred. The notice will include a URL that includes more details.

You may get the details of the notification in one of two ways.

Use the URL href and action provided in the notification.
Make a direct call to the associated API (such as Notifications API or Consent API)

Example Notification

For instance, if you've subscribed to the category MAINTENANCE with type PLANNED_OUTAGE and an event occurs, you'll receive a notification similar to this example:

{
  "category": "MAINTENANCE",
  "type": "PLANNED_OUTAGE",
  "notificationPayload": {
    "id":"d1c8260a-edd9-5cd0-9ebf-ad4c3dd29b01",
    "idType":"MAINTENANCE",
    "customFields":[{
      "name": "PROVIDER",
      "value": "mikomo"
    }]
  },
  "url": {
    "href": "https://api.akoya.com/notifications/v1/maintenance/d1c8260a-edd9-5cd0-9ebf-ad4c3dd29b01",
    "action": "GET"
  }
}

URL href and action

To use this method, simply use the URL provided in the notification with your service token. You'll receive a json object as a response (example below).

Direct call to associated API

You may also make a call to the associated API to get the notification details. For instance, for details related to a consent event, use the GET Consent Grant endpoint (link) with the id received in the notificationPayload.

Example response

{
            "id": "d1c8260a-edd9-5cd0-9ebf-ad4c3dd29b01",
            "category": "MAINTENANCE",
            "type": "PLANNED_OUTAGE",
            "institutionId": "mikomo",
            "startTime": "2000-01-26T00:00:00Z",
            "endTime": "2000-08-20T00:00:00Z",
            "title": "Akoya Support - Maintenance Outage",
            "message": "There's unplanned maintenance scheduled with mikomo for an API you have access to. Mikomo will be performing maintenance on PAYMENTS API in the production environment. The following APIs will be impacted: Payments; Given the nature of this impact, services may unavailable while the maintenance is occurring. Please contact us if you have any questions about this maintenance. To report a production issue with your API integration, log into the Akoya Support Portal to submit a support ticket.",
            "impactedService": ["payments"]
        },

Notification errors

Code	Description
`400`	Bad Request
`401`	Unauthorized to create a notification subscription
`405`	Method Not Allowed