Using Webhooks in ClearPoint
Webhooks allow apps to send automated messages to other apps. For example, it’s how PayPal tells your accounting application when your client pays you. They can also be leveraged to message teammates on Microsoft Teams or Slack when an Objective status becomes Below Plan in ClearPoint. Learn how to configure Webhooks in ClearPoint to connect to these other applications!
In This Article
First, we need to go to Zapier to create a URL that our Webhook can use. If you don’t already have an account, creating an account is free! Once you’ve logged in, click Make a Zap.
For your Trigger App, select Webhooks.
Select Catch Hook under Trigger Event. Click Continue.
Click Copy under Custom Webhook URL.
Log into ClearPoint. Open System Settings in the control panel and click on Admin Options.
Under Enterprise Features, click on Webhooks.
Click the plus icon to create a new webhook. Name the new webhook. Paste the URL from Zapier into the URL field. Under Options, select if you want to Fire on Scorecard Changes or Fire on Notifications. Choose the scorecard(s) or notification(s) that the Webhook should monitor for changes. Select a type of change. Click Save when finished.
After setting up the webhook, you should run a test to make sure the connection is configured correctly. For this set up, we will test adding a new objective. Click on the Objectives dropdown menu and select Manage Objectives. Click the plus icon to add a new objective. Give the objective a name and click Save.
Go back to Zapier and click Save & Continue.
Then, select Find Hook.
If configured correctly, you should see a green check mark for the sample Objective you created. Once you do this, you can begin setting up your Action. Select an Action, which occurs after your Webhook is triggered.
Once you’ve configured your Action step, you can click Turn Zap On.
To give you an idea for how webhooks could be leveraged in your account, there are some of our favorite use cases.
- Every time a Measure falls to Below Target, send me a message on Microsoft Teams.
- Any time a new Initiative is added in any Scorecard, send a message to our Project Team’s Slack channel.
- Every time an Objective is deleted, populate a line in a Google Sheet, so we have a running tab of all archived Objectives.
- When I am assigned as a Collaborator of an Initiative, put time on my calendar to review with the other Collaborators.