Webhooks Treftadaeth ar Legalesign

Beth yw webhooks treftadaeth

Mae webhooks treftadaeth yn ein system webhook hŷn. Os ydych chi'n ystyried defnyddio webhooks am y tro cyntaf defnyddiwch y system newydd - webhooks newydd

Byddwn yn parhau i gefnogi webhooks treftadaeth am amser estynnedig i sicrhau cydweddiad ôl-ddefnydd. Os bydd hynny’n newid byddwch yn cael digon o rybudd. Argymhellwn chi uwchraddio yn yr achos hwn i gyd, oherwydd mae’r webhooks amser real yn cael eu tarfu ar gyfer mwy o ddigwyddiadau, yn cynnwys mwy o wybodaeth ddefnyddiol, gellir eu hidlo’n fwy effeithiol ac mae’n digwydd yn gyflymach.

Mathau o webhook

Mae dau fath o webhook treftadaeth.

• Ar ôl [ddigwyddiad] (yn cael ei dad-ddiweddaru)
• Pob digwyddiad bob 6 munud (yn cael ei dad-ddiweddaru)

Sut i ychwanegu neu dynnu webhook

Ychwanegu neu dynnu gan ddefnyddio’r app gwe

Ewch i gosodiadau a byddwch yn gweld y panel webhooks. Mae’r ffurflen yn cynnwys reolau syml i ychwanegu neu dynnu webhooks

perygl

Mae’ch allwedd API yn seiliedig ar eich cyfrif ac nid grŵp unigol na sefydliad. Mae hyn yn rhoi mwy o hyblygrwydd i’ch allwedd API, ond bydd eich webhooks yn cael gwybodaeth o bob cyfrif lle rydych chi’n weinyddwr, dev a prod fel ei gilydd. I wahaniaethu webhooks yn ôl grŵp defnyddiwch y hidlydd, neu (y dull hen) creu defnyddiwr gweinyddwr newydd sy’n aelod o’r grŵp(tiau) targed yn unig, cael allwedd API iddynt, a defnyddio’r cyfrif hwnnw ar gyfer eich webhook.

Ychwanegu neu dynnu gan ddefnyddio’r API

Defnyddiwch geisiadau GET a POST syml dros yr REST API i restru, creu neu ddileu webhooks.

Am fwy o wybodaeth gweler y ddogfennaeth: API webhooks

Fformat webhook 'Ar ôl ...'

Mae’r rhain yn webhooks a dynnir ar gyfer digwyddiad penodol - arwyddo, creu, gwrthod, neu ymweliad methu.

Mae’r rhain yn cael eu cyflwyno fel ceisiadau POST i’ch url.

Mae’r rhain yn cynnwys enw’r ddogfen, cod digwyddiad, uri adnodd, tagiau a uuid y ddogfen. Dyma’r argraffiad o ngrok.

Fformat webhook diweddariad cyffredinol / 6 munud

Mae’r galwad 6 munud yn edrych fel hyn:

Fel y gallwch weld mae hefyd yn gais POST. Ond yr amser hwn mae’r holl wybodaeth wedi’i storio yn yr atyniad POST ‘data’ fel gwrthrych JSON.

Dyma’r gwrthrych JSON hwnnw’n fanwl:

[
  {
    "value": "5",
    "timestamp": "2022-07-11T07:28:25+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "10",
    "timestamp": "2022-07-11T07:28:26+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:28:55+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "40",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "100",
    "timestamp": "2022-07-11T07:29:09+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  }
]

Beth sy’n digwydd yma? Mae’r webhook diweddariad cyffredinol nawr yn rhoi’r holl fanylion i chi am beth ddigwyddodd wrth arwyddo dogfen, a phryd. Mae’n cynnwys diweddariadau digwyddiad ar gyfer y naill arwyddwr a’r ddogfen.

rhybudd

Fe sylwch fod rydym yn defnyddio’r geiriau ‘derbynnydd’ a ‘arwyddwr’. Mae’r rhain yn gyfnewidiol. Mae’r defnydd o ‘derbynnydd’ yn adlewyrchu’r rolau mwy cymhleth sydd ar gael yn awr yn Legalesign ac fe fydd yn enw newydd am ‘arwyddwr’ wrth i ni ddatblygu.

Stori data’r webhook hwn yw bod gwrthrych arwyddwr wedi cael ei greu (arwyddwr 5), anfonwyd (arwyddwr 10), cwblhaodd y sawl sy’n arwyddo eu maes (arwyddwr 30), ac arwyddo (arwyddwr 40), nododd y ddogfen fod ei meysydd wedi’u cwblhau (ddogfen 20) yna cael ei farcio fel wedi ei arwyddo (ddogfen 30), a wedyn yn barod i’w lawrlwytho (ddogfen 100).

Mae ‘100’ yn god digwyddiad arbennig i gadarnhau bod dogfen yn barod i’w lawrlwytho.

Statws dogfen

Statws	Esboniad
10	Anfonwyd
20	Meysydd wedi cwblhau
30	Wedi gorffen
40	Wedi tynnu (cyn arwyddo)
50	Wedi gwrthod

Statws arwyddwr

Statws	Esboniad
4	Heb anfon
5	Wedi trefnu anfon
10	Anfonwyd
15	E-bost wedi ei agor
20	Wedi ymweld
30	Meysydd wedi cwblhau
35	Meysydd wedi’u cwblhau heblaw am feysydd llofnodi
39	Tystio i lofnodi
40	Wedi gorffen
50	Wedi lawrlwytho
60	Wedi gwrthod

Dadansoddi webhooks yn y dangosfwrdd API

Mae pob webhook yn cael ei logio ac gallwch archwilio eu cynnwys a chôd statws http yn eich dangosfwrdd API. I ddysgu mwy edrychwch ar y tiwtorial Dangosfwrdd

Ewch yn uniongyrchol i ddangosfwrdd API.

Cysylltwch â ni

Dylai hynny gynnwys popeth y mae angen i chi wybod am webhooks treftadaeth.

Os oes gennych fwy o gwestiynau cysylltwch – support.legalesign.com.