🚧

Beta

Webhooks are in Beta. It's likely that small changes to event names and payloads may be made over time.

To join the Beta, please contact your account manager. Alternatively, contact [email protected] to get access.

You can use webhook subscriptions to receive notifications about particular events on Knoma. After you've subscribed to a webhook topic, your app can execute code immediately after specific events occur, instead of having to make API calls periodically to check their status.

For example, you can rely on webhooks to trigger an action in your app when a students loan application status changes. By using webhooks, you can make fewer API calls overall, which makes sure that your apps are more efficient and update quickly.

Getting started

  1. Log into the portal.
  2. Ping us a message on Live Chat or an email to [email protected] so we can switch on webhooks for your account.
  3. Visit settings, and click 'Webhooks'
25862586

Use the test console to send requests to your development environment (we recommend ngrok!)