Brukerveiledning Avbryt

Konfigurere en ny webhook

 

Veiledning for Adobe Acrobat Sign

Nyheter

Kom i gang

Administrer

Sende, signere og behandle avtaler

Avanserte avtalefunksjoner og arbeidsflyter

Integrere med andre produkter

Acrobat Sign-utvikler

Kundestøtte og feilsøking

Konfigurasjonsalternativer

Konfigurasjon av Webhook krever at fem elementer defineres:

  • Navn – det foreslås et intuitivt navn som andre administratorer lett kan forstå.
  • Omfang – hvor bredt nett skal webhooken fange? Konto og gruppe er tilgjengelig i grensesnittet.
    • API-en støtter omfangene Konto, Gruppe, Bruker og Ressurs.
    • Bare ett omfang per webhook kan defineres.
  • Nettadresse – måladressen som Acrobat Sign sendte JSON-nyttelasten til.
  • Hendelser – utløseren som får Acrobat Sign til å bygge JSON og sende til nettadressen.
    • Hver hendelse bygger en ny nyttelast som er relevant for utløserhendelsen.
    • Flere hendelser kan inkluderes i én webhook.
  • Varslingsparametere – varslingsparametrene identifiserer delene av Hendelse JSON-nyttelasten, slik at du kan velge bare delene av Hendelsen som er viktige for denne webhooken (og dermed redusere unødvendige data i til nettadressen din).

Når webhooken er fullt definert, klikker du på Lagre og den nye webhooken begynner å reagere for å utløse hendelser umiddelbart. 

Merk:

Konfigurer webhook-nettadressen for å svare på webhook-bekreftelses- og webhook-varslingsforespørsler i henhold til bekreftelsesprotokollen som er forklart ovenfor. Klient-ID-en (applikasjons-ID) som vil bli sendt til webhooks opprettet fra Acrobat Sign-webapplikasjonen vil være – UB7E5BXCXY

Konfigurer webhooken

Omfang

  • Konto: Alle de abonnerte hendelsene som oppstår i kontoen utløser push.
    • Kontoadministratorer har myndighet til å se alle webhooks definert for kontoen og alle gruppene i den kontoen.
  • Gruppe: Alle abonnerte hendelser som forekommer i den gruppen utløser push. MERK: Webhooks med gruppeomfang finnes bare for den ene gruppen.
    • Gruppeadministratorer vil bare se webhookene som er dedikert til gruppen. De kan ikke se webhooks på kontonivå eller webhooks som er bundet til andre grupper.
    • Kontoer som har Brukere i flere grupper aktivert, vil se alternativet for å angi gruppen omfanget skal brukes på.
  • Brukerkonto: Alle abonnerte hendelser for en brukerkonto utløser push. Webhooks på brukernivå kan bare opprettes via API.
  • Webhook på ressursnivå: Dette vil bli opprettet for en bestemt ressurs. Hendelser som er spesifikke for denne ressursen, vil bli flyttet til webhook-nettadressen. Webhooks på ressursnivå kan bare opprettes via API.

Nettadresse

En webhook-nettadresse er en server som lytter etter innkommende HTTPS POST-varslingsmeldinger som utløses når hendelser inntreffer.

Du må ha denne nettadressen for å abonnere på din webhook for hendelser.

  • Klienten må inkludere en HTTPS-URL som Acrobat Sign kan POST til. Denne nettadressen må være tilgjengelig på det offentlige internett.  
    • For eksempel vil ikke 127.0.0.1 og localhost-URI-er fungere.
    • Nettadresse-endepunktet må lytte på port 443 eller 8443 (bestemt av kunden når vedkommende definerer tilbakekall-nettadressen).
  • Kontroller at webhook støtter POST-forespørsler for innkommende hendelsesvarsler og GET forespørsler om bekreftelsesforespørselen.
  • Nettadressen bør ikke blokkeres av en brannmur.

Hendelser

Nedenfor er hendelsene som kan utløse en push til webhook-nettadressen, gruppert etter objekt og oppført i rekkefølgen funnet i brukergrensesnittet.

Verdien til venstre er verdien du vil se i Acrobat Sign-grensesnittet. Verdien til høyre er webhook-navnet i API-en.

For fullstendige detaljer om webhooks og deres nyttelaster, kan du se Utviklerveiledning for Acrobat Sign.

Avtaler:

UI-element Webhook-navn
Avtale alle hendelser AGREEMENT_ALL
Avtale opprettet AGREEMENT_CREATED
Avtale sendt AGREEMENT_ACTION_REQUESTED
Avtaledeltaker fullført AGREEMENT_ACTION_COMPLETED
Avtalearbeidsflyt fullført AGREEMENT_WORKFLOW_COMPLETED
Avtale utløpt AGREEMENT_EXPIRED
Avtale slettet AGREEMENT_DOCUMENTS_DELETED
Avtale kansellert AGREEMENT_RECALLED
Avtale avvist AGREEMENT_REJECTED
Avtale delt AGREEMENT_SHARED
Avtale fjernet for deling AGREEMENT_UNSHARE
Avtale automatisk fjernet for deling AGREEMENT_UNSHARE_AUTO
Avtale delegert AGREEMENT_ACTION_DELEGATED
Avtaledeltaker erstattet AGREEMENT_ACTION_REPLACED_SIGNER
Avtale endret AGREEMENT_MODIFIED
Avtaleendring bekreftet AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Avtale-e-post vist AGREEMENT_EMAIL_VIEWED
Avtale-e-post ble returnert AGREEMENT_EMAIL_BOUNCED
Avtaledokument sett AGREEMENT_DOCUMENTS_VIEWED
Avtaledokument som vises når et passord er brukt for å vise dokumentet AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Oppretting av avtale mislyktes AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Avtale synkronisert etter frakoblet hendelse AGREEMENT_OFFLINE_SYNC
Avtale lagt i hvelv AGREEMENT_VAULTED
Avtaledeltakers sosiale identitet godkjent AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Avtaledeltaker KBA-godkjent AGREEMENT_KBA_AUTHENTICATED
Avtaledeltakerens engangspassord på e-post er autentisert
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Avtalens utløp er oppdatert AGREEMENT_EXPIRATION_UPDATED
Avtalepåminnelse sendt AGREEMENT_REMINDER_SENT
Avtaleunderskrivernavn endret av underskriver AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Avtalepåminnelse igangsatt AGREEMENT_REMINDER_INITIATED
   
Avtale-webhooks er bare tilgjengelig via API
UI-element Webhook-navn
I/T
AGREEMENT_READY_TO_NOTARIZE
I/T
AGREEMENT_READY_TO_VAULT

 

Massesending:

UI-element Webhook-navn
Send samlet – alle hendelser MEGASIGN_ALL
Send samlet – opprettet
MEGASIGN_CREATED
Send samlet – delt
MEGASIGN_SHARED
Send samlet – tilbakekalt
MEGASIGN_RECALLED
Send samlet-påminnelse sendt MEGASIGN_REMINDER_SENT
Send samlet-påminnelse igangsatt MEGASIGN_REMINDER_INITIATED

 

Webskjemaer:

UI-element Webhook-navn
Alle hendelser for webskjema WIDGET_ALL
Webskjema opprettet
WIDGET_CREATED
Webskjema aktivert
WIDGET_ENABLED
Webskjema deaktivert
WIDGET_DISABLED
Webskjema endret
WIDGET_MODIFIED
Webskjema delt
WIDGET_SHARED
Oppretting av webskjema mislyktes
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Bibliotekmaler (bare API):

UI-element Webhook-navn
I/T LIBRARY_DOCUMENT_ALL
I/T LIBRARY_DOCUMENT_CREATED
I/T LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
I/T LIBRARY_DOCUMENT_MODIFIED

 

Varslingsparametere

Med varslingsparametere kan du tilpasse JSON-nyttelasten til bare spesifikke elementer i hendelsen.

For eksemepel i en hendelse som er Erstattet av en avtaledeltaker, kan det for eksempel hende at du bare vil ha avtaleinformasjonen og deltakerinformasjonen, mens dokumentinformasjonen utelates og reduserer den totale JSON-størrelsen som sendes til webhook-nettadressen din.

 

  • Avtale
    • Avtaleinfo – detaljert avtaleinformasjon basert på avtalens tilstand på tidspunktet for utløsende hendelse.
    • Informasjon om avtaledokument – inkluderer all dokumentinformasjon som genereres som et resultat av hendelsen.
    • Informasjon om avtaledeltaker – inkluderer eventuell deltakerinformasjon som et resultat av arrangementet.
    • Avtale signert dokument – gir det signerte PDF-dokumentet. 
      • Gjeldende for Arbeidsflytsavtalen gjennomført og Avtale alle hendelser.
  • Send samlet
    • Send samlet-info – detaljert informasjon om Send samlet-objektet som utløste hendelsen.
  • Nettskjema
    • Widgetinfo – detaljert informasjon om nettskjemaet som utløste hendelsen.
    • Widget-dokumentinformasjon – dokumentinformasjonen som er knyttet til webskjemaet.
    • Widget-deltakerinfo – informasjon om de definerte deltakerne i webskjemaet.

Få hjelp raskere og enklere

Ny bruker?