High-level overview for webhooks used with Akoya Notifications

Webhooks are HTTP callbacks that allow event-driven communication between two APIs. They allow apps to send automated messages or information to other applications. They’re like the postal service delivering a letter or package to your door. When a sender ships a package, you receive it without asking for it.

Who uses a webhook?

Webhooks are generally used in server-to-server communication from third-party services.

Why are they beneficial?

When email was a newer technology, checking email involved initiating a request to an email server, which would then download your emails to your email client. Later email systems synchronized automatically with your email client. Emails would download as you received them rather than on-demand.

That's what webhooks do for your application. You don't have to initiate checks for new information in your application code or as part of a batch process. Instead, webhooks push data to you whenever a triggering event occurs.

How do webhooks work at Akoya?

Akoya’s webhooks enable apps to retrieve status notifications for components in the Akoya network. You can decide what event type notifications you receive.

Just indicate what events you’re interested in and where we should send the notifications.

How to get started

You’ll need to do a few things:

  1. Retrieve your service credentials from the Data Recipient Hub. These are different than the clientId and secret used to make Akoya product API calls.
  2. Tell us which events you’re interested in receiving and where (API endpoint) Akoya should send them.
  3. Make sure Akoya can actually reach that endpoint. You’ll want to verify that your firewall can accept inbound connections over TCP 443 from Akoya to the server hosting your endpoint.
  4. Add some meaningful logic to process the information you receive from the webhook

Types of events you can receive at Akoya

We currently have two types of events available for you to consume: maintenance and consent.

  1. Maintenance: These are planned or unplanned outages that occur on the Akoya network.
  2. Consent: These are consent updates that your users make. You’ll be informed when a user revokes their consent at a data provider’s portal, or when they add or remove accounts.

See our technical guide for more details on using webhooks to receive Akoya notifications.