Handboek Annuleren

Een nieuwe webhook configureren

 

Handboek voor Adobe Acrobat Sign

Nieuwe functies

Aan de slag

Beheerder

Overeenkomsten verzenden, ondertekenen en beheren

Geavanceerde voorzieningen en workflows voor overeenkomsten

Integreren met andere producten

Acrobat Sign Developer

Ondersteuning en probleemoplossing

Configuratieopties

Bij de configuratie van de webhook moet u vijf elementen definiëren:

  • Naam : we raden een intuïtieve naam aan die andere beheerders gemakkelijk kunnen begrijpen.
  • Bereik: hoe groot is het 'vangnet' van de webhook? Account en Groep zijn beschikbaar in de interface.
    • De API biedt ondersteuning voor de bereiken Account, Groep, Gebruiker en Bron.
    • Er kan slechts één bereik per webhook worden gedefinieerd.
  • URL: de doel-URL waarnaar Acrobat Sign de JSON-payload heeft gepusht.
  • Gebeurtenissen: de trigger die ervoor zorgt dat Acrobat Sign de JSON bouwt en naar de URL pusht.
    • Elke gebeurtenis bouwt een andere lading die relevant is voor de activeringsgebeurtenis.
    • Een webhook kan meerdere gebeurtenissen bevatten.
  • Notificatieparameters: met de notificatieparameters worden de secties van de JSON-payload voor de Gebeurtenis geïdentificeerd, zodat u alleen die secties van de Gebeurtenis kunt selecteren die voor deze webhook belangrijk zijn (wat leidt tot minder onnodige gegevens die naar uw URL worden gestuurd).

Zodra de webhook volledig is gedefinieerd, klikt u op Opslaan, waarna de webhook direct kan reageren op activeringsgebeurtenissen. 

Opmerking:

Configureer uw webhook-URL om te reageren op de webhookverificatie en webhookmeldingsverzoeken volgens het verificatieprotocol dat hierboven is uitgelegd. De client-ID (toepassings-ID) die wordt verzonden naar webhooks die zijn gemaakt met de Acrobat Sign-webtoepassing, is - UB7E5BXCXY

De webhook configureren

Bereiken

  • Account: de pushmelding wordt geactiveerd door alle subscribed gebeurtenissen in de account.
    • Accountbeheerders kunnen alle webhooks bekijken die zijn gedefinieerd voor het account en alle groepen binnen dat account.
  • Groep: de pushmelding wordt geactiveerd door alle subscribed gebeurtenissen in de desbetreffende groep OPMERKING: door de groep bestreken webhooks bestaan alleen voor die ene groep.
    • Groepsbeheerders kunnen alleen die webhooks zien die aan hun groep zijn toegewezen. Ze kunnen de webhooks op accountniveau of webhooks die aan andere groepen zijn gebonden, niet zien.
    • Accounts waarvoor Gebruikers in meerdere groepen zijn ingeschakeld, zien de optie om de groep in te stellen waarop het bereik moet worden toegepast.
  • Gebruikersaccount: de pushmelding wordt geactiveerd door alle gebeurtenissen met aanmelding in een gebruikersaccount. Webhooks op gebruikersniveau kunnen alleen via een API worden gemaakt.
  • Webhook op bronniveau: dergelijke webhooks worden gemaakt voor een specifieke bron. De gebeurtenissen die specifiek zijn voor deze bron, worden via een pushmelding naar de webhook-URL gestuurd. Webhooks op bronniveau kunnen alleen via een API worden gemaakt.

URL

Een webhook-URL is een server die luistert naar binnenkomende HTTPS POST-meldingen die worden geactiveerd wanneer bepaalde gebeurtenissen plaatsvinden.

U hebt deze URL nodig om uw webhook bij gebeurtenissen aan te melden.

  • De client moet een HTTPS-URL opnemen waarnaar Acrobat Sign een POST-melding kan sturen. Deze URL moet openbaar zijn op internet.  
    • Zo zullen 127.0.0.1 en localhost-URI's bijvoorbeeld niet werken.
    • Het URL-eindpunt moet luisteren op poort 443 of 8443 (bepaald door de klant bij het definiëren van de callback-URL).
  • Controleer of de webhook ondersteuning biedt voor POST-aanvragen bij inkomende gebeurtenismeldingen en voor GET-aanvragen bij de verificatieaanvraag.
  • De URL mag niet worden geblokkeerd door een firewall.

Gebeurtenissen

Hieronder staan de gebeurtenissen die een push naar de webhook-URL kunnen activeren, gegroepeerd op object en vermeld in de volgorde die in de gebruikersinterface wordt gevonden.

De waarde aan de linkerkant is de waarde die u ziet in de gebruikersinterface van Acrobat Sign. De waarde aan de rechterkant is de naam van de webhook in de API.

Raadpleeg de handleiding voor ontwikkelaars van Acrobat Sign voor volledige informatie over de webhooks en hun payloads.

Overeenkomsten:

Gebruikersinterface-element Webhooknaam
Overeenkomst voor alle gebeurtenissen AGREEMENT_ALL
Overeenkomst gemaakt AGREEMENT_CREATED
Overeenkomst verzonden AGREEMENT_ACTION_REQUESTED
Deelnemer aan overeenkomst voltooid AGREEMENT_ACTION_COMPLETED
Overeenkomstworkflow voltooid AGREEMENT_WORKFLOW_COMPLETED
Overeenkomst verlopen AGREEMENT_EXPIRED
Overeenkomst verwijderd AGREEMENT_DOCUMENTS_DELETED
Overeenkomst geannuleerd AGREEMENT_RECALLED
Overeenkomst afgewezen AGREEMENT_REJECTED
Overeenkomst gedeeld AGREEMENT_SHARED
Overeenkomstdeling opgeheven AGREEMENT_UNSHARE
Overeenkomstdeling automatisch opgeheven AGREEMENT_UNSHARE_AUTO
Overeenkomst gedelegeerd AGREEMENT_ACTION_DELEGATED
Deelnemer aan overeenkomst vervangen AGREEMENT_ACTION_REPLACED_SIGNER
Overeenkomst gewijzigd AGREEMENT_MODIFIED
Wijziging van overeenkomst bevestigd AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Overeenkomst-e-mail bekeken AGREEMENT_EMAIL_VIEWED
Overeenkomst-e-mail niet bezorgd AGREEMENT_EMAIL_BOUNCED
Overeenkomstdocument weergegeven AGREEMENT_DOCUMENTS_VIEWED
Overeenkomstdocument weergegeven nadat een wachtwoord is toegepast om het document weer te geven AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Overeenkomst kan niet worden gemaakt AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Overeenkomst gesynchroniseerd na offlinegebeurtenis AGREEMENT_OFFLINE_SYNC
Overeenkomst gearchiveerd AGREEMENT_VAULTED
Deelnemer geverifieerd via identiteit op sociale media AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Identiteit van deelnemer geverifieerd via KBA AGREEMENT_KBA_AUTHENTICATED
Deelnemer van overeenkomst geverifieerd via OTP per e-mail
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Vervaldatum overeenkomst bijgewerkt AGREEMENT_EXPIRATION_UPDATED
Overeenkomstherinnering verzonden AGREEMENT_REMINDER_SENT
Naam ondertekenaar overeenkomst gewijzigd door ondertekenaar AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Herinnering voor overeenkomst gestart AGREEMENT_REMINDER_INITIATED
   
Overeenkomst Webhooks alleen beschikbaar via API
Gebruikersinterface-element Webhooknaam
N.v.t.
AGREEMENT_READY_TO_NOTARIZE
N.v.t.
AGREEMENT_READY_TO_VAULT

 

In bulk verzenden:

Gebruikersinterface-element Webhooknaam
In bulk verzenden: alle gebeurtenissen MEGASIGN_ALL
In bulk verzenden gemaakt
MEGASIGN_CREATED
In bulk verzenden gedeeld
MEGASIGN_SHARED
In bulk verzenden ingetrokken
MEGASIGN_RECALLED
Herinnering verstuurd voor bulkverzending MEGASIGN_REMINDER_SENT
Herinnering voor bulkverzending gestart MEGASIGN_REMINDER_INITIATED

 

Webformulieren:

Gebruikersinterface-element Webhooknaam
Webformulier: alle gebeurtenissen WIDGET_ALL
Webformulier gemaakt
WIDGET_CREATED
Webformulier ingeschakeld
WIDGET_ENABLED
Webformulier: uitgeschakeld
WIDGET_DISABLED
Webformulier gewijzigd
WIDGET_MODIFIED
Webformulier gedeeld
WIDGET_SHARED
Webformulier maken mislukt
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Bibliotheeksjablonen (alleen API):

Gebruikersinterface-element Webhooknaam
N.v.t. LIBRARY_DOCUMENT_ALL
N.v.t. LIBRARY_DOCUMENT_CREATED
N.v.t. LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
N.v.t. LIBRARY_DOCUMENT_MODIFIED

 

Meldingsparameters

Met meldingsparamters kunt u de JSON-payload aanpassen aan de specifieke elementen van de gebeurtenis.

Bij de gebeurtenis Deelnemer overeenkomst vervangen wilt u misschien alleen de elementen Informatie over overeenkomst en Informatie over deelnemer opnemen, en Informatie over documenten niet. Zo houdt u ook de totale verstuurde content van de JSON naar uw webhook-URL beperkt.

 

  • Overeenkomst
    • Agreement Info: gedetailleerde overeenkomst die de status van de overeenkomst op het moment van de activerende gebeurtenis wordt gebaseerd.
    • Informatie over overeenkomstdocument: bevat alle documenten die als gevolg van de gebeurtenis zijn gegenereerd.
    • Informatie over overeenkomstdeelnemer: bevat alle deelnemergegevens als gevolg van de gebeurtenis.
    • Document met ondertekende overeenkomst: de ondertekende PDF. 
      • Van toepassing op de gebeurtenissen Overeenkomstworkflow voltooid en Overeenkomst: alle.
  • In bulk verzenden
    • Informatie over In bulk verzenden: gedetailleerde informatie over het object In bulk verzenden dat de gebeurtenis heeft geactiveerd.
  • Webformulier
    • Widgetinfo: gedetailleerde informatie over het webformulier dat de gebeurtenis heeft geactiveerd.
    • Informatie over widgetdocument: de documentinformatie die is gekoppeld aan het webformulier.
    • Informatie over widgetdeelnemers: informatie over de gedefinieerde deelnemers in het webformulier.

Krijg sneller en gemakkelijker hulp

Nieuwe gebruiker?