For Developers
How to integrate with DealBuilder
DealBuilder makes it easy to connect your systems using API, webhooks, or GET requests. This allows you to automate workflows, reduce manual work, and ensure data flows seamlessly between DealBuilder and your business systems.
🛠️ Three simple ways to integrate
Webhooks – Receive data from DealBuilder whenever specific events occur (e.g., when a document is sent or signed).
GET request to DealBuilder – Pre-fill contracts automatically by sending data from your own system to DealBuilder.
API – Use our full API for automated document flow and product synchronization.
(See the API integration guide for full setup instructions.)
📡 1. Webhook Integration
Webhooks let your system automatically receive data from DealBuilder whenever defined events occur — such as when a document is sent, opened, or signed.
How to set up a webhook:
- Go to Admin → Webhooks in DealBuilder.
- Click Add webhook.
- Fill in the following fields:
- Name: Give the integration a descriptive name, e.g. From DealBuilder to CRM.
- URL: Add the endpoint that should receive the data.
- Error email: Add an email for notifications if something goes wrong.
- Event: Choose which event triggers the webhook (e.g. Document signed).
👉 Tip: Use a tool like webhook.site to preview how the data is structured for each event.
You can also review the sample data structure here:
Google Docs example – “Document signed” event
✅ Testing webhooks
After saving your webhook, you can run a test by clicking Run test. Note that you need existing data for the selected event — for example, a signed document if you’re testing the Document signed event.
If no matching data exists, the test will not run.
👉 Tip: Send and sign a test document first to have data ready.
🧩 Available webhook events:
- Document sent
- Document opened
- Document signed (includes all document data)
- Signing deadline expired
- Document sent for internal approval
- Document signed (per line item)
📥 2. Integration via GET request to DealBuilder
You can pre-fill contract templates automatically in DealBuilder by sending a GET request to:https://app.dealbuilder.io/Contract/CreateNewContractExternal
Include customer data such as company ID, email address, and other parameters in the URL to pre-populate contract fields directly from your own system.
Example:
https://app.dealbuilder.io/contract/createnewcontractexternal?email=ole@eposten.com&phonenumber=004741434544&companyname=Eksempelfirma%20AS
&customername=Ole+Hansen&address=Eksempelveien%2032+0101+Oslo&visitaddress
=Eksempelveien%2032+0101+Oslo&orgnumber=321654789&CRMid=4963935370
Once the contract is signed, webhooks can return the customer ID and related data back to your system automatically.
Available query parameters:
You can also define custom fields under Admin → Templates → Custom fields to further tailor your contracts.
Custom fields can be shown in the document or remain hidden as metadata, available through the webhook payload.
Example custom fields:
Custom fields can be placed at the top of the document (below fields such as Company Name and Contact Person) or under the line items from the product module.
Custom fields can also be hidden, meaning they contain a value that isn’t visible to the recipient but is stored as part of the document metadata and accessible through the webhook dataset.
🚀 What this means in practice
You can easily add a Create new contract button or link to DealBuilder from your own platform. When clicked, DealBuilder opens pre-filled with customer data and any custom fields you’ve included.
This saves time and ensures that every agreement contains accurate information.
If you already have templates set up in DealBuilder with your company’s texts, terms, and attachments, users only need to make minor adjustments before sending a contract — typically in seconds.
To use this integration, users must have an active DealBuilder account and be logged in.
📦 Product module for dynamic agreements
DealBuilder includes a product module that lets you add products directly into templates.
Users can insert products from your DealBuilder product library alongside the pre-filled customer data — making it quick, flexible, and seamless to send quotes and agreements.
🎥 Watch how it works
Want to see it in action? Check out these short demo videos:
👉 How to set up a webhook
👉 How to send data to DealBuilder (GET request)
🔌 3. API Integration
The DealBuilder API provides full automation of your document workflows — whether for pre-built PDFs or template-based documents.
Three main document flows supported by the API:
- Automated PDF signing – Send a finished PDF with signers and optional metadata. The template ID defines deadlines, signing methods, and notifications. Webhooks send status updates back.
- Automated document generation from template – Push product, pricing, and contract data from an external system; DealBuilder generates the document and sends it for signing automatically.
- Semi-automated workflow – Same as above, but users can review and adjust the document before sending. Ideal when internal approval is needed.
See the full API integration guide for detailed setup instructions.
🔄 Product synchronization
The API also supports product synchronization between DealBuilder and your system, keeping product data always up to date in your templates and documents.
📧 Need help integrating?
You can set up integrations yourself using our API, webhooks, or GET requests — or contact us (or one of our integration partners) for assistance.
Our partners can help build customized integrations tailored to your needs and automate key business processes.
👉 Get in touch with us to get started.