| 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 page. access enabled. To learn more, please reach out to support@goeverbright.com |
Webhooks (also called a web callback or HTTP push API) are a way for Sighten EverBright to provide other applications with real-time event-based information.
...
First, navigate to Settings and select Integrations Integration Settings on the left sidebar.The Credentials and Webhooks tab is the second tab on this page.
...
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:
...
From there, an Add Webhook modal will open.
...
Name your webhook: this should be something simple that identifies the webhook and is associated with your account to assist with any triaging of EverBright logs.
Select an Event
...
that will act as a trigger for the webhook
The available events are:
Contract Recipient Status Change
Contract Status Change
Change Order Status Change
Homeowners Signed Contract
Milestone Comment Created
Milestone Status Change
Task Comment Created
Qualification Update
Site Archived
...
Stage Transition
Proposal Action
Invoice Status Change
Workflow Status Change
Determine some settings for your Webhook:
Test credentials - toggle: If this is toggled on, you will see a “test” label next to the credential name. And the credentials will only be used on Sighten testing environments like Onboard. If it is toggled off, it will be used on our production environment, Engine.
Org. specific authentication - toggle: if this is turned on, you will be able to add API keys for multiple organizations in the same credential.
Ex: If you have this toggled on, then you can add API keys for more than one organization. As you can see above, you can continue to add organizations by clicking the Add Organization Credential button. You can remove an organization’s credentials, by clicking the Remove Organization button to the right of the dropdown.
Select the Authentication type:
...
Headers - You will be asked to provide a Key and a Value.
...
Basic - With this method, you provide a username and password into the request header.
...
Token - This authentication method works by ensuring that each request to a server is accompanied by a signed token which the server verifies for authenticity and only then responds to the request. You will be asked to provide a Key and a Value.
...
AWS4 - You will be asked to provide an Access Key, a Secret Key, AWS Region, AWS Service, and a Base Endpoint.
...
HMAC-SHA256 - You will be asked to provide a Client ID and a Client Secret.
...
No Authentication - You do not need to provide any information in addition to the header(s).
...
URL Path - this is the address for the API call when the event is triggered.
Credential - this field is a dropdown menu. Each webhook is tied to a 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 - this field is a dropdown menu: you can select PUT, POST, or PATCH. Most partners select POST
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.