Lähetä asiakirjatapahtumat järjestelmääsi webhookeilla
Webhook lähettää allekirjoitetun JSON-viestin osoitteeseesi, kun asiakirja lähetetään, avataan, allekirjoitetaan, valmistuu, hylätään, vanhenee tai perutaan. Vaatii Pron; omistajille ja ylläpitäjille.
Tämä käännös on vanhempi kuin englanninkielinen artikkeli, joten jotkin yksityiskohdat ovat voineet muuttua. Lue englanninkielinen versio
Tällä sivulla
Webhook lähettää viestin URL-osoitteeseesi aina, kun asiakirjalle tapahtuu jotain, jotta oma järjestelmäsi voi toimia sen perusteella. Webhookit kuuluvat Pro-tilaukseen: ne toimivat työtilassa niin kauan kuin jollakin sen omistajista on Pro, ja vain omistajat ja ylläpitäjät voivat hallita niitä. Jokaisella työtilalla on omat webhookinsa.
Lisää webhook
- Avaa tilivalikosta Asetukset ja brändi ja siirry kohtaan Integraatiot.
- Paina Lisää webhook.
- Anna Päätepisteen URL-osoite. Sen on alettava merkeillä
https://ja oltava julkinen: yksityisten verkkojen osoitteet, Sealsimplen omat osoitteet ja URL-osoitteet, joissa on käyttäjätunnus ja salasana, hylätään. - Lisää halutessasi Nimi, valitse Tapahtumat (kaikki ovat aluksi valittuina) ja paina Lisää webhook.
- Kopioi esiin tuleva Allekirjoitusavain ja paina Lähetä testitapahtuma.
Työtilassa voi olla enintään 10 webhookia.
Tapahtumat
document.sent: Asiakirja lähetettydocument.viewed: Vastaanottaja avasi, kerran vastaanottajaa kohdendocument.signed: Allekirjoittaja allekirjoitti, kerran allekirjoittajaa kohdendocument.completed: Valmis: kaikki ovat allekirjoittaneetdocument.declined: Hylättydocument.expired: Vanhentunutdocument.canceled: Peruttu
Mitä lähetämme
POST-pyynnön, jonka runko on JSON-muodossa: id (sama jokaisella yrityksellä, joten voit ohittaa kaksoiskappaleet), event, created_at, workspace_id, document, jossa on id, title, status ja url, sekä yhtä henkilöä koskevissa tapahtumissa recipient, jossa on name, email ja role. Perutun asiakirjan tila on voided. Itse allekirjoitettua PDF:ää ei lähetetä. Testitapahtuman event-arvo on test, ja siinä on keksitty asiakirja ja allekirjoittaja.
Tarkista allekirjoitus
Jokaisessa pyynnössä on Sealsimple-Signature-otsake, esimerkiksi t=1700000000,v1=…, sekä otsakkeet Sealsimple-Event ja Sealsimple-Delivery. Näin tarkistat allekirjoituksen:
- Ota pyynnön raaka runko täsmälleen sellaisena kuin se saapui.
- Lue otsakkeesta
t(Unix-aika sekunteina) jav1. - Laske HMAC-SHA256 merkkijonosta, jossa ovat
t, piste ja runko, käyttäen avaimena koko allekirjoitusavaintasi, ja esitä tulos heksadesimaalina pienillä kirjaimilla. - Hyväksy pyyntö vain, jos tulos on sama kuin
v1(vertaa vakioajassa) jaton enintään muutaman minuutin vanha.
Kohdan Näin yhdistät alla oleva Tarkista allekirjoitus (Node.js) näyttää tämän koodina, ja siinä on Kopioi koodi -painike. Uusi avain vaihtaa avaimen heti, joten päivitä tarkistuksesi heti sen jälkeen.
Uudelleenyritykset, loki ja keskeyttäminen
Vastaa 2xx-tilakoodilla 10 sekunnin kuluessa. Muuten yritämme myöhemmin uudelleen, yhteensä enintään 6 kertaa noin vuorokauden aikana. Uudelleenohjauksia ei seurata, ja vastaus 410 lopettaa yritykset. Toimitusloki näyttää viimeiset 50 viestiä ja päätepisteesi vastaukset, ja Lähetä uudelleen lähettää viestin uudelleen.
Kun 20 toimitusta on epäonnistunut peräkkäin, keskeytämme webhookin (Keskeytetty virheiden vuoksi) ja lähetämme sähköpostia työtilan omistajille. Korjaa päätepiste, ota webhook uudelleen käyttöön ja lähetä lokista uudelleen tarvitsemasi viestit. Voit myös keskeyttää webhookin sen kytkimellä: keskeytyksen aikana tapahtuneita tapahtumia ei lähetetä myöhemmin. Ilman Pro-tilausta webhookit säilyvät, mutta ne eivät lähetä mitään.