...
From there, an Add Webhook modal will open.
...
Name your webhook: this should be something simple that identifies the webhook.
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:
PUT: is most-often utilized for update capabilities
POST: utilized to create new resources.
PATCH: utilized when we only send the data that we need to modify without modifying or altering other parts of the data
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.
...