Konfigurera en ny webhook

Konfigurationsalternativ

Konfigurering av webhook kräver att fem element definieras:

• Namn – ett intuitivt namn som andra administratörer lätt kan förstå föreslås.
• Omfång – hur brett nätet är som används av en webhook? Kontot och gruppen är tillgängliga i gränssnittet.
  • API:et stöder omfattningar för konto, grupper, användare och resurser.
  • Endast ett omfång per webhook kan definieras.
• URL – mål-URL:en som Acrobat Sign skickade JSON-nyttolasten till.
• Händelser – utlösaren som gör att Acrobat Sign skapar JSON och skickar den till avsedd URL.
  • Varje händelse skapar en egen nyttolast som är relevant för den utlösande händelsen.
  • Flera Händelser kan inkluderas i en webhook.
• Meddelandeparametrar – meddelandeparametrarna identifierar de delar av Händelsens JSON-nyttolast, så att du kan välja endast de avsnitt som är viktiga för denna webhook i Händelsen (och därmed minska onödig data som skickas till URL:en).

När en webhook är helt definierad, klicka på Spara, och denna nya webhook börjar direkt reagera på utlösande händelser. 

Omfång

• Konto: Alla prenumerationshändelser som inträffar på kontot utlöser push-åtgärden.
  
  • Kontoadministratörer har behörighet att se alla webbhookar definierade för kontot och alla grupper i kontot.
• Grupp: Alla prenumerationshändelser som inträffar i gruppen utlöser push-åtgärden. OBS! Webbhookar med gruppomfång finns bara för den gruppen.
  • Gruppadministratörer kan bara se webhookar som är dedikerade till deras grupp. De kan inte se webbhooks på kontonivå eller webhooks som är bundna till andra grupper.
  • Konton som har Användare i flera grupper aktiverat, ser alternativet att ange gruppen som omfånget ska tillämpas på.
    
• Användarkonto: Alla prenumerationshändelser för ett användarkonto utlöser push-åtgärd. Webhooks på användarnivå kan bara skapas via API.
• Webhook på resursnivå: Detta skapas för en specifik resurs. Händelser som är specifika för denna resurs överförs till aktuell webhook-URL. Webhookar på resursnivå kan bara skapas via API.

URL

En webhook-URL är en server som lyssnar efter inkommande HTTPS-POST-aviseringar som utlöses när händelser inträffar.

Du behöver denna URL för att prenumerera på webhook för händelser.

• Klienten måste innehålla en HTTPS URL som Acrobat Sign kan skicka POST-aviseringar till. Denna URL måste vara tillgänglig på offentligt Internet.  
  • Till exempel kommer 127.0.0.1 och localhost-URI:er inte att fungera.
  • URL-slutpunkten måste lyssna på port 443 eller 8443 (bestäms av kunden när återanrops-URL:en definieras).
• Se till att webhooken stöder POST-förfrågningar för inkommande händelseaviseringar och GET-förfrågningar för verifieringsförfrågan.
• Webbadressen bör inte blockeras av en brandvägg.

Händelser

Nedan visas de händelser som kan utlösa en push till webhook-URL:en, grupperade efter objekt och listade i den ordning som finns i användargränssnittet.

Värdet till vänster är det som visas i användargränssnittet i Acrobat Sign. Värdet till höger är webhookens namn i API:et.

Fullständig information om webbhookarna och deras nyttolaster finns i Utvecklarhandbok för Acrobat Sign.

Avtal:

Massutskick:

Webbformulär:

Biblioteksmallar (endast API):

Meddelandeparametrar

Med meddelandeparametrar kan du anpassa JSON-nyttolasten till specifika element i händelsen.

I en händelse av Avtalsdeltagare ersatt kanske du bara vill ha Avtalsinformation och Deltagarinformation och utelämna Dokumentinformation, och minska den totala storleken på den JSON som skickas i webhook-URL:en.

• Avtal
  • Avtalsinformation – detaljerad avtalsinformation baserad på avtalets status vid tidpunkten för den utlösande händelsen.
  • Dokumentinformation för avtal – inkluderar all dokumentinformation som genereras som ett resultat av händelsen.
  • Information om avtalsdeltagare – inkluderar all deltagarinformation som ett resultat av händelsen.
  • Signerat avtalsdokument – tillhandahåller den signerade PDF-filen. 
    • Gäller händelserna Avtalsarbetsflödet har slutförts och Alla avtal.
• Massutskick
  
  • Information om massutskick – detaljerad information om det Massutskickobjekt som utlöste händelsen.
• Webbformulär
  • Widgetinformation – detaljerad information om webbformuläret som utlöste händelsen.
  • Information om Widget-dokument – dokumentinformationen som är associerad med webbformuläret.
    
  • Widget-deltagarinformation – information om definierade deltagare i webbformuläret.