Een nieuwe webhook configureren

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. 

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:

In bulk verzenden:

Webformulieren:

Bibliotheeksjablonen (alleen API):

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.