Table of contents
This guide provides an overview of notifications and steps for adding and managing notification targets using the Highnote dashboard.
Overview
Note: Using Highnote notifications requires the assistance of a developer.
Notifications work by using webhooks for events that occur within your Highnote implementation. Notifications allow you to monitor card program activity. The following use cases represent some common ways notifications are used:
- Complete asynchronous onboarding flows
- Monitor for changes or alerts
- Transfer data from Highnote into third-party systems such as a CRM or analytics solution
For more information on using notifications, see the Notifications developer guide.
Add notification target
Notifications targets use configurable events that send a notification to your webhooks. See the Notifications developer guide for information on setting up webhooks.
Once your webhooks are configured, you can add notification targets using the Highnote dashboard. Refer to the following steps to add notification targets:
- From the Highnote dashboard, click Developers and select the Notifications tab.
- Click Add Notification Target.
- Provide a Notification Name and Target URL. The target URL is your webhook's address.
- In the notification events section, use the toggles to select events to deliver to your notification target. For an overview of events, see the Events Reference developer guide.
- Optional - Add Email. This field is only available in the live environment and is used by Highnote to send you notifications about deactivated webhooks.
- Click Add Webhook Notification Target.
- Copy your notification target key and store it in a safe location.
- Click I've copied my key.
Notification targets are not active upon creation. To activate a notification target, see Activate notification target.
Manage notification target
You can also manage notification targets from the Highnote dashboard to monitor details, delivery attempts, and event history. Use the following steps to view the details of a notification target:
- From the Highnote dashboard, click Developers and select the Notifications tab.
- Hover over your notification target and click View Details.
On the notification target details page, you can view the following information:
- Status: The status of a notification target. For a full list of statuses, see the Events Reference developer guide
- Details: Details including the created and updated dates, type, subscriptions (events), and endpoint URL
- Delivery attempts: A log of delivery attempts to your endpoint URL and the corresponding status
- History: History of notification target statuses
You can also execute the following actions on the notification target details page:
- To change notification events for your target, click Add/Remove Subscriptions.
- To rename your notification target, click More and select Rename Target.
- To change your email, click More and select Add/Update Email or Remove Email.
Activate notification target
By default, notification targets are not active at creation. Use the following steps to activate a notification target using the Highnote dashboard:
- From the Highnote dashboard, click Developers and select the Notifications tab.
- Hover over your notification target and click View Details.
- Click Activate Target.
Delete notification target
Use the following steps to delete a notification target using the Highnote dashboard:
- From the Highnote dashboard, click Developers and select the Notifications tab.
- Hover over your notification target and click View Details.
- Click Delete Target.