Automate workflows and integrate external tools with ease.
Webhooks let your Avvoka environment talk to other tools in real-time. You can trigger automated messages or data transfers to external systems based on document activity—saving time and keeping everyone aligned. Whether it’s sending a Slack update when a document is signed, or notifying an internal system when a questionnaire is submitted, Webhooks offer powerful, customisable automation.
Who can set up Webhooks?
Anyone with Organisation Support access can create and manage Webhooks. These can apply:
Across your entire organisation
For individual profiles
On specific templates
You can also define exactly which document events will trigger a Webhook.
Getting Started: Creating a Webhook
Head to the Support tab on the main navigation bar.
Click into the Webhooks section in the left-hand menu.
You’ll see a list of all active Webhooks across your organisation.
Click Add new to set one up.
Fill in the key details:
Title – e.g. “Notify Slack when document signed”
Organisation – which organisation this Webhook belongs to
All Events? – tick this if you want to trigger the Webhook for every document event
Active? – make sure this is ticked if you want it to run
Then click Save to move forward.
Adding Webhook Targets
A Webhook needs somewhere to send the data – this is your Target.
On your newly created Webhook, click + Add Target
Set the following details:
Optional: Add Authentication
Set a Username and Password for basic auth
Include any Custom Headers as needed
Click Save to lock it in.
To test the Webhook, click Test – you’ll see the response at the bottom of the Target page.
You can always edit, deactivate, or delete a Target using the three-dot menu on the right-hand side.
Choosing Your Events
If you didn’t tick “All Events”, you can add individual triggers.
Click + Add under Events and choose from options like:
Document created, signed, completed, deleted
Questionnaire submitted
Entry updated
Many more (see full technical list below)
Click Save once you’ve added the relevant triggers.
Limiting by Profiles or Templates
By default, a Webhook applies to your full organisation. But you can narrow the scope:
Profiles – e.g. only trigger for your HR team
Templates – e.g. only trigger for NDAs or Loan Agreements
To limit:
Click + Add under Profiles or Templates
Select one or more from the dropdown
Click Save
Note: Templates must not be marked as “Private” to appear in this list.
Webhook Payload Structure
Here’s an example of what’s sent when your Webhook fires:
jsonCopyEdit{ "event": "document_created", "source_type": "Document", "source_id": 1, "triggered_by_type": "User", "triggered_by_id": 1, "payload_id": "f2c71994-de0d-436d-8596-abf172bcc18f", "message": "Document 'Document Name' was 'created' by Administrator", "created_at": "2021-04-23T14:13:04.421+01:00", "meta": null }
Key fields to note:
Field | Description |
| The action that triggered the Webhook |
| ID of the document |
| User ID or null if triggered by system |
| Can be used to retrieve full payload via API |
Use Cases
Alert your Slack channel when a contract’s fully signed
Push completed document data into your CRM
Trigger downstream workflows based on questionnaire logic
Supported Events (full list)
Event | Identifier |
Document Created |
|
Document Locked/Unlocked |
|
Document Deleted |
|
External Signature Pending |
|
Document Completed/Signed |
|
Ready to Sign |
|
Entry Updated |
|
Questionnaire Submitted |
|
Document Entries Processed |
|
Developer Notes
Requests are sent as POST
Payload can be formatted for Slack or as JSON
You can retrieve full payload details using the
payload_id
with our API
Need Support?
Drop us a message at help@avvoka.com if you’d like help setting up your first Webhook or exploring more advanced configurations. We’d be happy to walk you through options tailored to your existing workflows.