Spring videre til hovedindholdet

Sådan opsætter du Web Hooks

Opsæt Web Hooks for at modtage statusopdateringer fra Addo Sign i realtid, så du ikke behøver at spørge API’et løbende. Når der sker en ændring, sendes der automatisk en callback.

⚠️ Du skal have administratorrettigheder for at kunne foretage de ændringer, der beskrives i denne artikel.

Brug af Web Hooks

Du kan bruge Web Hooks, også kaldet web callbacks eller HTTP push APIs, til at lade din virksomhed modtage opdateringer i realtid, når en transaktion i Addo Sign ændrer status.

Det gør det muligt at koble Addo Sign sammen med virksomhedens website eller webapps med egne handlinger.

Web Hooks: Når en transaktion ændrer status

En Web Hook udløses, hver gang en transaktion ændrer status. De mest almindelige statusændringer er:

  • Afsluttet: Transaktionen er underskrevet af alle parter.

  • Udløbet: Signeringsfristen er overskredet.

  • Transaktionsstatus ændret: Notifikationer kan sendes ved hvert trin, for eksempel:

    1. Transaktion startet.

    2. Afventer ny underskriver.

    3. Underskrevet.

    4. Returneret til afsender/undeskriver.

    5. Fejl under afsending/modtagelse.

  • Aflyst: Dækker typisk situationer, hvor en transaktion er stoppet manuelt eller trukket tilbage før afslutning. Når afsenderen annullerer signeringsprocessen, sker der ikke flere handlinger som f.eks. signering, påmindelser eller redirects, og transaktionen betragtes som afsluttet uden at nå frem til fuldførelse.

  • Returlevering: Når en e-mail returneres til systemet, udløses en callback til afsenderen med de relevante oplysninger.

  • Afvist: En underskriver har afvist at underskrive dokumentet.

  • Dokumentgruppe afvist: En dokumentgruppe er blevet afvist af én eller flere underskrivere. I modsætning til Rejected stopper denne status ikke nødvendigvis transaktionen, fordi du på forhånd kan definere præcist, hvilke dokumenter der skal underskrives for at gennemføre den.

  • Dokument åbnet: En underskriver har åbnet ét eller flere dokumenter i transaktionen.

  • Dokument færdiggjort: En underskriver har underskrevet et dokument i transaktionen.

  • Omdirigerings URL: Sender underskriveren videre til et bestemt website efter underskrift. Landingssidens URL skal starte med enten http:// eller https://.

  • Invitation: En invitation er blevet sendt til en underskriver.

  • Påmindelse: Der er sendt en ny påmindelse til underskriveren.

Kort fortalt omdirigerer du underskriveren til en URL, afhængig af hvilke ændringer, der sker i transaktionen.

Du behøver altså ikke selv at opsætte et API for at hente data. Opdateringer sendes til dig live, hver gang der sker en statusændring.

Certifikat og sikkerhed

Nogle serveropsætninger kræver et sikkerhedscertifikat, for at Web Hooks kan fungere korrekt.

Certifikatet leveres normalt af virksomhedens IT-afdeling.

Besvarede dette dit spørgsmål?