The Notification Webhook add-on enables ROOK to send real-time notifications to clients regarding actions within their integration with us. This feature includes notifications for new user creation, connection or disconnection of data sources, failed notifications to user data sources, and undelivered information alerts. Our aim is to provide clients with timely updates without the need for API queries, leveraging webhooks for automatic notifications. This enhancement ensures that clients receive up-to-date information, streamlining their workflows and improving efficiency. This add-on is available upon request. To access it, contact your account manager.
Types of notifications
The Notification 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 events 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 your account manager through an official channel. 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.
Once subscribed, can I unsubscribe?
Yes, you can unsubscribe from the Notification Webhook by contacting our account manager to initiate the unsubscription process.