Webhook

← Back to Integrations

Overview

Below is a business‑focused explanation of the Webhook document type, written for practical use within Dafater.

---

What the Webhook is Used for in Business Operations

The Webhook is used to automatically notify external systems when specific business events happen in Dafater.
Instead of manually exporting data or checking reports, the Webhook ensures that important updates are instantly shared with other tools your business relies on.

In simple terms, the Webhook acts as a real‑time messenger between Dafater and other business applications.

---

Prerequisites and Setup Requirements

Before using a Webhook, the following should be in place:

• A clear understanding of which business event should trigger the notification
  (for example: a document being approved, submitted, or updated)
• An external system or service that is ready to receive updates automatically
• Agreement with the receiving team or vendor on what information is needed and when
• Proper business approval, since Webhooks can send sensitive operational data

This setup is usually done once and then runs continuously in the background.

---

Typical Workflow and How It Fits into Business Processes

A typical business workflow using a Webhook looks like this:

1. A business event occurs in Dafater
   (such as a transaction being confirmed or a record being approved)
2. The Webhook is triggered automatically
3. The Webhook sends the relevant business information to the connected external system
4. The external system takes action
   (such as updating records, triggering follow‑up actions, or sending notifications)

This removes delays, reduces manual work, and ensures that all systems stay aligned.

---

Key Business Scenarios Where Webhook Is Essential

The Webhook is especially valuable in the following situations:

• Financial integrations
  Automatically informing accounting or payment systems when transactions are completed
• Customer communication
  Triggering external messaging or notification platforms after key customer events
• Compliance and reporting
  Sending real‑time updates to monitoring or audit systems
• Operational automation
  Keeping multiple business systems in sync without manual intervention
• Partner integrations
  Sharing updates with vendors, service providers, or partners instantly

In all these cases, the Webhook helps the business operate faster and with fewer errors.

---

Important Considerations for Users

When using the Webhook, users should keep the following in mind:

• Only enable Webhooks for important and well‑defined business events
• Ensure that shared data follows company policies and confidentiality rules
• Test the setup carefully before using it in live business operations
• Monitor outcomes to confirm that external systems are responding as expected
• Avoid creating unnecessary Webhooks, as too many notifications can cause confusion

Used correctly, the Webhook becomes a powerful tool for automation and real‑time coordination across your business ecosystem.

---

In summary, the Webhook helps Dafater communicate automatically with other business systems, enabling faster decisions, smoother operations, and better integration across the organization.

Basic Information

• Module: Integrations
• Document Type: Other

Fields

Field Name	Label	Type	Required	Options	Description
webhook_doctype	DocType	Link	✓	DocType	Dafater document type that triggers the webhook.
webhook_docevent	Doc Event	Select		afterinsert, onupdate, onsubmit, oncancel, ...	Specific Dafater document event that sends the webhook.
enabled	Enabled	Check		-	Enable or disable this webhook configuration.
condition	Condition	Small Text		-	Logical rule determining when the webhook should trigger.
html_condition	html_condition	HTML		Condition Examples: ,	Reference examples explaining valid webhook trigger conditions.
request_url	Request URL	Small Text	✓	-	Target endpoint URL receiving webhook requests.
isdynamicurl	Is Dynamic URL?	Check		-	Allow dynamically generated request URLs using document data.
timeout	Request Timeout	Int		-	Maximum waiting time for webhook request response.
backgroundjobsqueue	Background Jobs Queue	Autocomplete		-	Queue used by Dafater to process webhook requests.
request_method	Request Method	Select	✓	POST, PUT, DELETE	HTTP method used to send the webhook request.
request_structure	Request Structure	Select		, Form URL-Encoded, JSON	Format of data sent in the webhook request.
enable_security	Enable Security	Check		-	Enable request signing for secure webhook communication.
webhook_secret	Webhook Secret	Password		-	Secret key used to sign and verify webhook requests.
webhook_headers	Headers	Table		Webhook Header	Custom HTTP headers sent with the webhook request.
webhook_data	Data	Table		Webhook Data	Key-value data fields included in webhook payload.
webhook_json	JSON Request Body	Code		Jinja	Custom JSON payload template using document data.
preview_document	Select Document	Dynamic Link		webhook_doctype	Sample Dafater document used to preview webhook data.
meets_condition	Meets Condition?	Data		-	Indicates whether selected document satisfies the condition.
previewrequestbody	Request Body	Code		-	Preview of final webhook request body.

Child Tables

Headers (Webhook Header)

Field Name	Label	Type	Required	Options	Description
key	Key	Small Text		-	HTTP header name sent by Dafater webhook requests
value	Value	Small Text		-	Header value included by Dafater in webhook requests

Data (Webhook Data)

Field Name	Label	Type	Required	Options	Description
fieldname	Fieldname	Select	✓	-	Target document field receiving webhook value in Dafater
key	Key	Data	✓	-	Webhook payload key mapped to Dafater field

Permissions

Role	Read	Write	Create	Delete	Submit	Cancel
System Manager	✓	✓	✓	✓

Related DocTypes

DocType	Relationship	Module
Webhook Request Log	Linked from	Integrations