Groov API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Listen for events on your Groov account so your integration can automatically trigger reactions.

Get real-time notifications

Webhooks are "user-defined HTTP callbacks". Groov uses webhooks to notify your application when an event happens regarding your connected ledger account. In our setup, Webhooks should be used to understand asynchronous events such as when a ledger account authorises their account connection to you via Groov, data aggregation is complete, insights are available, in-life data for an ongoing connected account changes/gets added.

How Groov uses webhooks

A webhook enables Groov to push real-time notifications to your app. Groov uses HTTPS to send these notifications to your app as a JSON payload. 

Steps to setup webhooks

Please follow the steps below to setup your webhook URLs:

  1. Create a webhook endpoint as an HTTP endpoint (URL) on your local server.

  2. Handle requests from Groov by parsing each event object, return 2xx response status codes.

  3. Test that your webhook endpoint is working properly using the Groov test toggle/sandbox account

  4. Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.

  5. Register your publicly accessible HTTPS URL in the Groov dashboard.

Register your webhook URL on Groov

via dashboard setup

Please follow the steps below to register your webhook URL(s) on Groov dashboard:

On this page:


Related pages

  • No labels