Testing Partner Notifications

To confirm that your notification implementation works correctly, we recommend that you leverage our self-serve notification testing tool in Developer Portal. This is available in our demo environment only.

This tool enables you to trigger specific notification webhooks to be sent to your application’s webhooks URL. Notification test event payloads will also be available when polled via our Events API. For more information about setting up webhooks for your application, reference our webhooks guide.

To get started, sign into your Developer Portal account. Under the partner application that you’d like to test with, select the “Test notifications” tab.

Select the specific notification category that you want to test. For a list of all partner notification categories, reference this table.

When a notification is triggered, we will automatically apply it to a correctly configured demo company. This is a demo company that we will create on your behalf, and can be identified by the following company_name: Demo notification testing. You can find this company under the "Demo Companies" tab in Developer Portal. We recommend that you isolate your notification testing to this specific demo company.

We enable you to trigger notification.*.created events in Developer Portal. For actionable notifications with associated resolution events, we recommend that you perform end-to-end testing to ensure that your application receives a notification.*.resolved event once the underlying action item has been completed.

Behind the scenes, we will generate and apply test data to the Demo notification testing company. Please note that you may receive other non-notification webhook events in your application’s event stream.

📘

We don’t yet support self-serve testing for all notification categories, but more to come soon. If you need assistance in triggering a specific notification event that is not available in Developer Portal, please contact your technical solutions representative.

Example

If you’d like to simulate an information_request notification to be sent to your application’s webhook URL, start by selecting the category in the Developer Portal form.

When you receive the notification.information_request.created event, query for notification details to build the notification in your application. Since this is actionable, the notification in your application should have a call-to-action, in which a link to our company_information_requests flow should be embedded. Once the information request has been submitted, you should expect to receive a notification.information_request.resolved event.