For utviklere
Hvordan integrere med DealBuilder
Med DealBuilder kan du enkelt integrere systemene dine ved hjelp av API, webhooks eller GET-forespørsler. Dette gir deg mulighet til å automatisere arbeidsflyten, redusere manuelt arbeid og sikre at data flyter sømløst mellom DealBuilder og andre forretningssystemer.
Integrasjonsguide for API integrasjon.
DealBuilder tilbyr en integrasjonsguide for hvordan du kan integrere DealBuilder i egne systemer. Se guiden her.
🛠️ Tre enkle måter å integrere på:
- Webhooks – Motta data fra DealBuilder når spesifikke hendelser skjer (f.eks. når et dokument blir sent eller signert).
- GET-forespørsel til DealBuilder – Send data fra egne systemer til DealBuilder ved å forhåndsutfylle kontrakter automatisk.
- API – Fullverdig API for automatisert dokumentflyt og produktsynkronisering.
(Se guide for oppsett av API-integrasjoner her).
📡 1. Integrasjon via webhooks
Webhooks lar deg automatisk motta data fra DealBuilder til ditt system hver gang en definert hendelse skjer. Dette kan for eksempel være når et dokument sendes, åpnes eller signeres.
Slik setter du opp en webhook:
- Gå til Admin > Webhooks i DealBuilder.
- Trykk på Legg til webhook.
- Fyll inn følgende:
- Navn: Gi integrasjonen et beskrivende navn, f.eks. Fra DealBuilder til CRM.
- URL: Legg inn endepunktet som skal motta data.
- E-post ved feil: Fyll inn en e-postadresse for varslinger dersom noe går galt.
- Hendelse: Velg hva som skal trigge webhooken (f.eks. Dokument signert).
👉 Tips: For å teste webhooken kan du bruke en tjeneste som webhook.site for å se hvordan dataen struktureres på hver av eventene.
Se egen side for fullstendig dokumentasjon på DealBuilder sine webhooks her: https://app.dealbuilder.io/webhookdocs
✅ Testing av webhooks
Når webhooken er lagret, kan du teste at alt fungerer. Trykk på "Kjør test", men vær oppmerksom på at det må være data i kontoen din for det eventet du tester.
For eksempel:
Hvis du har satt opp en webhook med hendelsen "Dokument fullført", må du ha et signert dokument i DealBuilder-kontoen din for å kjøre en test. Systemet vil automatisk bruke det siste signerte dokumentet som testdata.
Hvis kontoen din ikke har noen relevante data, vil testen ikke kunne gjennomføres.
👉 Tips: Send først ut et dokument til signering og signer det, slik at du har noe å teste med.
🧩 Tilgjengelige hendelser for webhooks:
- Dokument sendt – Når et dokument sendes fra DealBuilder.
- Dokument åpnet – Når mottakeren åpner dokumentet.
- Dokument signert – Når en enkelt signatar signerer. Én webhook per signatar.
- Dokument fullført – Når alle nødvendige signaturer er på plass og den signerte PDF-en er klar. Alle dokumentdata følger i én webhook.
- Dokument fullført (per ordrelinje) – Sender én webhook per ordrelinje når dokumentet er fullført.
- Signeringsfrist utløpt – Når signeringsfristen utløper.
- Signeringsfrist endret – Når signeringsfristen endres.
- Dokument sendt til intern godkjenning – Når dokumentet sendes til intern godkjenning.
- Dokument tilbakekalt – Når et dokument tilbakekalles før det er fullført.
Automatisk nytt forsøk ved feil
Ved opprettelse av webhooks kan du aktivere automatisk nytt forsøk ved feil. DealBuilder forsøker da igjen etter 10 minutter og deretter med gradvis lengre intervaller, i maksimalt 10 dager.
📥 2. Integrasjon via GET-forespørsel til DealBuilder
Du kan fylle ut kontraktsmaler automatisk i DealBuilder ved å sende en GET-forespørsel til følgende endepunkt:
https://app.dealbuilder.io/Contract/CreateNewContractExternal
Ved å inkludere informasjon som kunde-ID, organisasjonsnummer, e-postadresse og andre data i URL-en, kan du forhåndsutfylle kontrakter direkte fra ditt eget system.
Eksempel:
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
Når brukeren åpner lenken, velger vedkommende først dokumentmal. Den valgte malen åpnes deretter med opplysningene fra GET-forespørselen forhåndsutfylt. Brukeren må ha tilgang til DealBuilder og være innlogget.
Når kontrakten blir signert, kan du bruke webhooks til å hente ut kunde-ID og annen tilhørende informasjon, slik at dataen automatisk sendes tilbake til ditt system.
📋 Du kan fylle ut DealBuilder med følgende datapunkter automatisk:
Du kan opprette egne felter på hver dokumentmal under Admin > Maler > Velg mal > Egendefinerte felter.
Feltets ID brukes direkte som query-parameter i GET-lenken. Har du eksempelvis et felt med ID customerID, kan verdien sendes inn slik:
&customerID=12345
Feltene kan vises i dokumentet eller lagres som skjulte metadata som returneres via webhook. De kan også brukes som variabler i dokumentteksten, eksempelvis {cf_customerID}, som automatisk erstattes med feltets verdi.
Egendefinerte felter kan plasseres flere steder i dokumentet, blant annet øverst i dokumentet (under Firmanavn, Kontaktperson osv.) eller under ordrelinjene fra produktmodulen. Feltene kan også brukes som variabler direkte i dokumentteksten. Hvis et felt for eksempel har ID ValueOfABC, kan det settes inn i teksten som {cf_ValueOfABC}. Når dokumentet opprettes, erstattes variabelen automatisk med verdien som er lagt inn i feltet.
Egendefinerte felter kan også være skjulte. Da kan feltet inneholde en verdi uten at den vises som et eget felt i dokumentet for mottakeren. Verdien lagres som metadata på dokumentet og kan returneres gjennom webhook.
🚀 Hva betyr dette i praksis?
Dette betyr at dere enkelt kan sette opp en knapp eller link til DealBuilder i deres eget system. Når brukeren klikker på denne for å opprette en ny kontrakt eller et tilbud, åpnes DealBuilder ferdig utfylt med informasjon om motparten (f.eks. kunden) og eventuelle skreddersydde felter som kunde-IDer eller spesifikke prosjektdetaljer.
Ved å forhåndsutfylle kontrakter med data fra deres system, sparer dere både tid og sikrer at riktige opplysninger følger med i avtalene.
Fra før av kan dere ha klargjort maler i DealBuilder som inneholder deres egne avtaletekster, vilkår og vedlegg. Når brukeren starter en ny kontrakt fra sitt system, trenger de kun å justere innholdet i avtalemalen før de sender ut et tilbud eller en kontrakt – dette kan gjøres på få sekunder.
For at dette skal fungere må brukerne det er snakk om også ha en brukertilgang i DealBuilder, som de på forhånd er logget inn i DealBuilder med.
📦 Produktmodul for dynamiske avtaler
DealBuilder har også en egen produktmodul som gjør det mulig å legge til produkter direkte i avtalemalene på en dynamisk måte.
Dette betyr at brukeren, i tillegg til forhåndsutfylt kundeinformasjon, også kan legge til produkter fra produktbiblioteket i DealBuilder før avtalen eller tilbudet sendes til signering. Dette gir en rask, fleksibel og helhetlig prosess for både kundeavtaler og tilbudshåndtering.
🎥 Se hvordan det fungerer
Vil du se hvordan du kan integrere DealBuilder med dine egne systemer?
Vi har laget en kort video som viser deg hele prosessen – fra oppsett av webhooks til testing og bruk.
👉 Slik setter du opp en ny webhook: https://www.loom.com/share/7e9821361b1f4e2e952c3eab538b1c34?sid=4d93fdd8-6e2d-4a2d-890c-d2a66ca08bd7
👉 Slik kan du sende data til DealBuilder (GET-forespørsel /Query URL): https://www.loom.com/share/87d7c294d1fa4e28870c4fbeae4a992e?sid=676db381-5536-4252-b542-18279ef1335f
🔌 3. Integrasjon via API
DealBuilders API gir deg fleksibel og kraftig automatisering for hele dokumentflyten – både for ferdige PDF-er og malbaserte dokumenter.
API-dokumentasjon
Full teknisk dokumentasjon for DealBuilders API finner du her:
https://api.dealbuilder.io/swagger/index.html
Dokumentasjonen er også tilgjengelig i JSON-format:
https://api.dealbuilder.io/swagger/v1/swagger.json
JSON-versjonen kan blant annet brukes sammen med AI-verktøy for hjelp til å utvikle og feilsøke integrasjoner.API-et har baseadresse https://api.dealbuilder.io og bruker API-nøkkel i x-api-key-headeren for autentisering.
📌 Tre hovedtyper dokumentflyt via API:
- PDF-signering (automatisk)
Send inn en ferdig PDF med signatarer og eventuelle egendefinerte felter/metadata. Mal-ID styrer frister, signeringsmetode, varsling og mer. Dokumentet sendes automatisk til signering, og webhooks gir deg oppdatering tilbake. - Dokument generert fra mal (automatisk)
Eksternt system sender inn data som produkter, antall, priser, rabatt, vilkår, vedlegg, osv. DealBuilder genererer dokumentet basert på mal, og sender det automatisk til signering. Webhooks gir deg oppdatering tilbake. - Halvautomatisk dokumentflyt
Samme som over, men brukeren får mulighet til å gjøre justeringer i dokumentet før det sendes ut manuelt fra DealBuilder. Perfekt når noe bør kvalitetssikres før utsending. Webhooks gir deg oppdatering tilbake.
Muligheter med DealBuilder API
DealBuilders API gir mulighet til å automatisere hele dokumentflyten fra egne systemer. Du kan blant annet:
- Opprette dokumenter fra maler eller ferdige PDF-filer.
- Opprette dokumenter som utkast eller sende dem direkte til signering.
- Administrere dokumenter, hente dokumentinformasjon og følge signeringsstatus.
- Hente signerte PDF-er og tilhørende dokumentdata.
- Søke, filtrere og sortere dokumenter, blant annet med fritekstsøk, signeringsdato og dokumentnummer.
- Opprette, oppdatere og synkronisere produkter.
- Overføre egendefinerte felter, metadata, produkter, priser, vilkår og vedlegg.
- Hente signeringslenker og integrere signeringsprosessen i egne systemer.
- Motta automatiske oppdateringer om dokumenthendelser gjennom webhooks.
Se fullstending guide for hvordan du setter opp API-integrasjoner her.
Organisasjonshierarki for konsern og partnere
DealBuilder støtter organisasjonshierarkier med ubegrenset antall nivåer av organisasjoner og selskaper. Dette gjør det mulig å speile strukturen i større konsern, virksomheter med mange avdelinger eller partnerorganisasjoner.API og webhooks kan administreres sentralt på et overordnet nivå og gjelde for hele organisasjonshierarkiet. Dermed kan man etablere én felles integrasjon som håndterer dokumentflyten på tvers av flere selskaper og avdelinger.
Personnummer ved BankID-signering
For godkjente kunder kan DealBuilder også tilgjengeliggjøre signatarens personnummer gjennom integrasjonen ved BankID-signering. Tilgangen må aktiveres særskilt.
Integrert signering (embedded signing)
DealBuilder støtter integrerte signeringsflyter der signeringslenker kan hentes via API og presenteres direkte i kundens eget system, uten at signeringsinvitasjonen må sendes via DealBuilder.Automatisk utsendelse av ferdig signerte dokumenter til signatarene kan også deaktiveres per dokumentmal. Dermed kan virksomheten selv håndtere både utsendelse av signeringslenker og kommunikasjon etter fullført signering.
🔄 Produktsynkronisering
API-et vil også støtte synkronisering av produkter mellom DealBuilder og dine egne systemer, slik at du alltid har oppdatert produktdata tilgjengelig i dokumentene dine.
📧 Trenger du hjelp med integrasjoner?
Du kan sette opp integrasjonene selv ved hjelp av API, webhooks eller GET-forespørsler, få innspill eller hjelp av oss, eller kontakte en av våre integrasjonspartnere for bistand. Våre partnere hjelper deg med å bygge skreddersydde integrasjoner som passer dine behov og automatiserer viktige prosesser.
👉 Ta kontakt med oss så via vårt kontaktskjema, så hjelper vi deg i gang.