| Info |
|---|
Note: this feature is only available to customers with API integrations who have expressed interest in managing their own webhooks. If this feature is turned on, and you have Organization Admin permissions then you can view this pageintegration. To learn more, please reach out to support@sighten.io. |
Webhooks (also called a web callback or HTTP push API) are a way for Sighten to provide other applications with real-time event-based information.
...
Above is an example of an account with no webhooks set up.
Before you can create a webhook, you must create credentials. Please follow instructions here to create credentials.
How do I add Webhooks to my account?
To add a credentialwebhook, click the green Add Webhook button highlighted below:
...
Name your webhook: this should be something simple that identifies the webhook and is associated with your account to assist with any triaging of Sighten logs.
Select an Event to base the webhook off of.
The available events are:
Contract Recipient Status Change
Contract Status Change
Milestone Comment Created
Milestone Status Change
Task Comment Created
Qualification Update
Site Archived
Determine some settings for your Webhook:
URL Path: this is the address for the API call when the event is triggered.
Credential - dropdown: Each webhook is tied to a specific credential. If it is a test webhook, then you will only see test credentials and if it is a production credential, you will only see production credentials.
HTTP Method - dropdown: you can select PUT, POST, or PATCH.
Test Webhook - toggle: This determines if the webhook is applied in a test (Onboard) or production environment (Engine). Once your webhook is created, there will be a test label next to the name for test webhooks.
Active - toggle: This determines if the webhook is active or not. Once your webhook is created, there will be an inactive label next to the name for webhooks that have been deactivated.
...