Brugerhåndbog Annuller

Konfigurer en ny webhook

 

Adobe Acrobat Sign-håndbog

Nyheder

Kom godt i gang

Administrer

Send, underskriv og administrer aftaler

Avancerede aftalefunktioner og arbejdsforløb

Integrer med andre produkter

Acrobat Sign-udvikler

Support og fejlfinding

Konfigurationsindstillinger

Konfiguration af webhook kræver, at der defineres fem elementer:

  • Navn– der foreslås et intuitivt navn, som andre administratorer nemt kan forstå.
  • Omfang – hvor bredt er det net, som webhooken fanger? Konto og Gruppe er tilgængelige i grænsefladen.
    • API'en understøtter omfangene Konto, Gruppe, Bruger og Ressource.
    • Der kan kun defineres ét omfang per webhook.
  • URL – den mål-URL, som Acrobat Sign skubbede JSON-nyttedataene til.
  • Hændelser – den udløser, der får Acrobat Sign til at oprette JSON og skubbe den til URL'en.
    • Hver enkelt hændelse opbygger en anden nyttedata, der er relevant for udløserhændelsen.
    • Flere hændelser kan inkluderes i én webhook.
  • Notifikationsparametrenotifikationsparametrene identificerer afsnittene i JSON-nyttedataene til hændelsen, så du kun kan vælge de afsnit i hændelsen, der er vigtige for denne webhook (og dermed reducere unødvendige data sendt til din URL).

Når webhook er fuldt defineret, skal du klikke på Gem, hvorefter den nye webhook begynder at reagere for at udløse hændelser med det samme. 

Bemærk:

Konfigurer din webhook-URL til at svare på webhook-bekræftelsen og webhooknotifikationsanmodningerne i henhold til den bekræftelsesprotokoll, som forklares ovenfor. Det klient-id (Program-id), der sendes til webhooks, som oprettet fra webprogrammet Acrobat Sign, er - UB7E5BXCXY

Konfigurer webhook

Omfang

  • Konto: Alle de abonnerede hændelser, der forekommer på kontoen, udløser skubbet.
    • Kontoadministratorer har tilladelse til at se alle webhooks, der er defineret for kontoen, og alle grupper inden for den pågældende konto.
  • Gruppe: Alle de abonnerede hændelser, der forekommer i denne gruppe, udløser skubbet. BEMÆRK: Gruppebaserede webhooks findes kun for den ene gruppe.
    • Gruppeadministratorer vil kun se de webhooks, der er dedikeret til deres gruppe. De kan ikke se webhooks på kontoniveau eller webhooks, der er bundet til andre grupper.
    • Konti, der har Brugere i flere grupper aktiveret, vil se muligheden for at indstille gruppen, som omfanget skal anvendes på.
  • Brugerkonto: Alle tilmeldte begivenheder for en brugerkonto udløser push. Webhooks på brugerniveau kan kun oprettes via API.
  • Webhook på ressourceniveau: Dette vil blive oprettet for en bestemt ressource. Begivenheder, der er specifikke for denne ressource, vil blive skubbet til webhook-URL'en. Webhooks på ressourceniveau kan kun oprettes via API.

URL

En webhook-URL er en server, der lytter efter indgående HTTPS POST-meddelelser, der udløses, når begivenheder opstår.

Du skal bruge denne URL for at abonnere på dit webhook til begivenheder.

  • Klienten skal indeholde en HTTPS-URL, som Acrobat Sign kan POST til. Denne URL skal være tilgængelig på det offentlige internet.  
    • For eksempel fungerer 127.0.0.1 og localhost-URI'er ikke.
    • URL-slutpunktet skal lytte på port 443 eller 8443 (bestemmes af kunden, når tilbagekaldelses-URL'en defineres).
  • Sørg for, at webhook understøtter POST-anmodninger om indgående begivenhedsmeddelelser, og GET anmodninger om bekræftelsesanmodningen.
  • URL'en må ikke blokeres af en firewall.

Hændelser

Nedenfor er de hændelser, der kan udløse et skub til webhook-URL'en, grupperet efter objekt og anført i den rækkefølge, der findes i brugergrænsefladen.

Værdien til venstre er den værdi, du ser i Acrobat Sign-grænsefladen. Værdien til højre er webhook-navnet i API'en.

Du kan finde alle oplysninger om webhooks og deres nyttedata i Vejledning til Acrobat Sign-udviklere.

Aftaler:

UI-element Webhook-navn
Aftale alle hændelser AGREEMENT_ALL
Aftale oprettet AGREEMENT_CREATED
Aftale sendt AGREEMENT_ACTION_REQUESTED
Aftaledeltager fuldført AGREEMENT_ACTION_COMPLETED
Aftalens workflow fuldført AGREEMENT_WORKFLOW_COMPLETED
Aftale udløbet AGREEMENT_EXPIRED
Aftale slettet AGREEMENT_DOCUMENTS_DELETED
Aftale annulleret AGREEMENT_RECALLED
Aftale afvist AGREEMENT_REJECTED
Aftale delt AGREEMENT_SHARED
Aftale ikke delt AGREEMENT_UNSHARE
Aftale ikke delt auto AGREEMENT_UNSHARE_AUTO
Aftale delegeret AGREEMENT_ACTION_DELEGATED
Aftaledeltager udskiftet AGREEMENT_ACTION_REPLACED_SIGNER
Aftale ændret AGREEMENT_MODIFIED
Aftaleændring kvitteret for AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Aftalemailen vist AGREEMENT_EMAIL_VIEWED
Aftalemail blev ikke sendt AGREEMENT_EMAIL_BOUNCED
Aftaledokument set AGREEMENT_DOCUMENTS_VIEWED
Aftaledokument set, når der er anvendt en adgangskode til at se dokumentet AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Aftaleoprettelse mislykket AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Aftale synkroniseret efter offlinehændelse AGREEMENT_OFFLINE_SYNC
Aftale sat i boks AGREEMENT_VAULTED
Aftaledeltagerens sociale identitet godkendt AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Aftaledeltager KBA-godkendt AGREEMENT_KBA_AUTHENTICATED
Mailengangskode for aftalens deltager godkendt
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Aftaleudløb opdateret AGREEMENT_EXPIRATION_UPDATED
Aftalepåmindelse sendt AGREEMENT_REMINDER_SENT
Aftaleunderskriverens navn er ændret af underskriveren AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Aftalepåmindelse igangsat AGREEMENT_REMINDER_INITIATED
   
Aftale-webhooks er kun tilgængelige via API
UI-element Webhook-navn
NA
AGREEMENT_READY_TO_NOTARIZE
NA
AGREEMENT_READY_TO_VAULT

 

Send i massevis:

UI-element Webhook-navn
Send i massevis – alle hændelser MEGASIGN_ALL
Send i massevis – oprettet
MEGASIGN_CREATED
Send i massevis – delt
MEGASIGN_SHARED
Send i massevis – tilbagekaldt
MEGASIGN_RECALLED
Påmindelse om masseafsendelse sendt MEGASIGN_REMINDER_SENT
Påmindelse om masseafsendelse igangsat MEGASIGN_REMINDER_INITIATED

 

Webformularer:

UI-element Webhook-navn
Webformular – alle hændelser WIDGET_ALL
Webformular – oprettet
WIDGET_CREATED
Webformular – aktiveret
WIDGET_ENABLED
Webformular – deaktiveret
WIDGET_DISABLED
Webformular – ændret
WIDGET_MODIFIED
Webformular – delt
WIDGET_SHARED
Webformular – oprettelse mislykket
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Biblioteksskabeloner (kun API):

UI-element Webhook-navn
NA LIBRARY_DOCUMENT_ALL
NA LIBRARY_DOCUMENT_CREATED
NA LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
NA LIBRARY_DOCUMENT_MODIFIED

 

Parametre for notifikationer

Med notifikationsparametre kan du tilpasse JSON-nyttelasten til blot specifikke elementer i begivenheden.

I en Aftaledeltager udskiftet-hændelse vil du f.eks. muligvis kun have aftaleoplysningerne og deltageroplysningerne, idet du udelader dokumentoplysningerne og reducerer den samlede størrelse af JSON, der sendes til din webhook-URL.

 

  • Aftale
    • Aftaleoplysninger – detaljerede aftaleoplysninger baseret på aftalens tilstand på tidspunktet for den udløsende begivenhed.
    • Oplysninger om aftaledokument – inkluderer alle dokumentoplysninger, der genereres som resultat af hændelsen.
    • Oplysninger om aftaledeltager – inkluderer eventuelle deltageroplysninger som resultat af hændelsen.
    • Aftale - underskrevet dokument – leverer den underskrevne PDF-fil. 
      • Gælder for Aftalens workflow afsluttet og Hele aftalen-begivenheder.
  • Send i massevis
    • Send i massevis – detaljerede oplysninger om det Send i massevis-objekt, der udløste hændelsen.
  • Webformular
    • Widgetoplysninger – detaljerede oplysninger om webformularen, der har udløst hændelsen.
    • Oplysninger om Widget-dokument – de dokumentoplysninger, der er knyttet til webformularen.
    • Oplysninger om widget-deltager – oplysninger om de definerede deltagere i webformularen.

Få hjælp hurtigere og nemmere

Ny bruger?