ROOK offers a range of actions related to users, data, and clients. These actions include linking or unlinking data sources, extracting, processing, and delivering data, and utilizing the Data Webhook to notify clients when a user event or webhook is available.
Previously, ROOK lacked a way to notify clients about various user actions occurring within their integration with ROOK. Clients could only access partial information about actions executed in their integration. To address this, we have introduced the Notification Webhook, our new add-on designed to send notifications to clients about actions within their ROOK integration. This includes creating new users, connecting or disconnecting data sources, failed notifications to user data sources, and notifications of undelivered information. Our goal is to provide clients with timely updates without requiring API queries, using webhooks to deliver automatic notifications. This optimization ensures clients have up-to-date information and streamlines their workflows.
This webhook provides three types of notifications:
User management
This webhook notifies you whenever a user interacts with the ROOKConnect integration, except for Events and Summaries, which are covered by our Data Webhook. The actions that trigger notifications include:
- New user creation
- New data source linking for a user
- Data source unlinking for a user
Failed user data extractions
This notification alerts you when ROOK is unable to extract user event or summary data due to various factors while querying a user's data source. These factors are external to ROOK and may include:
- Data source failures
- Unavailable user information
- Token or credential issues
- Permission problems
Rejected information
This notification alerts you when you have not accepted a submission of events or summaries from our Data Webhook. For more details, please read the following article.
Subscribe to Notification Webhook
This add-on is optional. To subscribe, please contact our sales department. You will need the following information:
- URL to receive webhook notifications
- Two URLs are required: one for your Sandbox environment and one for your Production environment.
Frequently Questions
Is this the same webhook where we receive documents for new events and summaries of our users?
No, the webhook for receiving new events and summaries is called the "Data Webhook." The "Notification Webhook" only communicates user interaction actions, failed communications to user data, and the resending of rejected information.
Note: Be sure to use different URLs to receive notifications for each webhook.
Can I use the same URL for the Notification Webhook in both environments?
Yes, you can use the same URL for both environments, but we do not recommend it. Using the same URL might lead to an overload of notifications and cause confusion.
Is it mandatory to subscribe to the Notification Webhook?
No, this add-on is optional. Clients can choose to subscribe if they need to receive automatic notifications about actions within their ROOK integration.
How can clients subscribe to the Notification Webhook?
To subscribe to the Notification Webhook, clients should contact our sales department. You need to provide two URLs to receive webhook notifications: one for the Sandbox environment and another for the Production environment.
Once subscribed, can I unsubscribe?
Yes, you can unsubscribe from the Notification Webhook by contacting our sales team to initiate the unsubscription process.
What types of notifications does the Notification Webhook offer?
The Notification Webhook provides three types of notifications:
- User management:Receive alerts whenever a user interacts with the ROOK integration, except for events and summaries, which are notified through the Data Webhook.
- Failed user data extractions:Alerts when ROOK does not receive a response when querying a user's data source.
- Rejected information:Notifications when a submission of events or summaries from the Data Webhook has not been accepted.