Webhooks

Open Settings, then Webhooks. An admin chooses an https URL on port 443 and at least one event.

Steps

1. Choose New webhook. The dialog title is New webhook.
2. Enter URL. The placeholder is https://. Choose Events.
3. Choose Create webhook.
4. The dialog title changes to Copy your secret. It says “You won’t see this secret again.” Choose Copy, then Done.
5. Open Webhook actions to Edit, Rotate secret, Disable or Enable, or Delete.

The columns are URL, Events, Status, and Last delivery. Status is Active or Disabled. Last delivery says “None” until an attempt has been made. Choosing that value, or Deliveries in the menu, opens a sheet titled Deliveries. An empty sheet says “No deliveries yet.”

Create shows “Webhook saved”. Delete asks “Delete this webhook?” and “Deliveries to this URL will stop.” A webhook that fails four times in a row says “Disabled after 4 failed deliveries. Enable it from the row menu.” A redirect is a failure and is not followed.

Events

Contract created, Contract updated, Status changed, Contract renamed, Owner changed, File uploaded, Key date approaching, Task due, Task stage changed, Note added, Note edited, Note deleted, Counterparty created, Counterparty updated, and Counterparties merged.

A contract event carries the event type, the contract id, the workspace id, and when it happened. Note events add the note id. They do not include the note text. Counterparty events carry the counterparty id. A merge also carries the source ids. A rename is its own event and is left out of Contract updated. A later webhook does not receive events that already happened.

Addresses that are refused

“Use an https URL.” means the address is not https, or it has a user name or password. “Use port 443.” means another port. “That address cannot be used.” means a private or reserved address. “Use a shorter URL.” means it is over 2,048 characters. “Choose at least one event.” means no event was ticked. A loopback name is refused.