Webhooksi seadistamise juhend

Webhooks (Veebihaak) võimaldab käivitada automaatseid toiminguid (actions) välistes süsteemides, kui ERPLY Books’is toimuvad konkreetsed sündmused. Nii saavad teised süsteemid raamatupidamises toimuvast koheselt teavituse.

Webhooksid käivituvad teatud sündmuste korral, näiteks:

  • Uue arve lisamisel
  • Kliendi kirjete uuendamisel
  • Tehingu kustutamisel

Selle asemel, et muudatusi käsitsi kontrollida, edastab Webhook teave teistele süsteemidele koheselt.

Webhooksi seadistamine

    1. Vajutage Sätted→ Üldised sätted
    2. Leidke Veebihaak (Webhook)
    3. Klõpsake Halda

Uue Webhooksi lisamine

Webhooki lisamisel peate kindlasti seadistama kolm veergu:

1. Tabelid

Valige, millist tabelit soovite jälgida. Saadaolevad valikud:

  • Articles – Tooted ja teenused
  • Customers and suppliers – Kliendid ja tarnijad (kontaktid)
  • Tax Rates – Maksumäärad
  • Dimensions/Projects – Mõõtmed/Projektid 
  • Project groups – Projektigrupid
  • Documents – Kõik dokumenditüübid (müügiarved, ostuarved, saatelehed jne)
  • Emails – E-kirjad

2. Lisa tegevus (Add activity)

Valige, millist tüüpi muudatust jälgida:

  • INSERT – Kui lisatakse midagi uut 
  • UPDATE – Kui uuendatakse midagi 
  • DELETE – Kui kustutatakse kirje 

3. Loo ühendus (Create connection)

See määrab, mis juhtub edasi, kui webhook käivitatakse. Ühendus kasutab eelnevalt loodud kohandatud integratsiooni (Custom Integration) konfiguratsioonile, mille peate eraldi seadistama (vt allpool).

4. Lisa filter (valikuline)

On olemas ka neljas veerg, mis on vaikimisi peidetud (add filter), mis võimaldab teil seada reegleid, millal webhook peaks käivituma.

  1. Klõpsake Lisa filter
  2. Lisage tingimused, et täpsustada, millal Webhook peaks täpselt käivituma (nt type=ARTICLE_PRODUCT, et Webhooks käivituks vaid siis, kui tegu on valmistoote (Completed Product) tüübiga)

NB! Filtri väärtused vastavad API välja nimedele ja väärtustele. Kontrollige täpsete väljade nimede ja kehtivate väärtuste jaoks ERPLY Booksi API dokumentatsiooni.

Kohandatud integratsiooni seadistamine

Webhookid vajavad kohandatud (custom) integratsiooni, et määrata kuhu ja kuidas andmeid saata.

  1. Minge jaotisse Sätted→ Integratsioonid
  2. Valige Custom API (viimane valik)
  3. Klõpsake Halda
  4. Lisage uus rida

Integratsiooni seadistamine

Peate määrama:

URL / IP – Lõpp-punkt, kuhu webhooki andmed saadetakse (nt https://teie-süsteem…)

Päringu meetod  (HTTP meetod)

  • POST
  • GET
  • Või muu vajalik HTTP meetodid

Päringu Päised (Valikuline) Lisage vajalikud päised, näiteks:

  • Rakenduse konfiguratsioon
  • Autentimise tokenid
  • API võtmed

Päringu sisus (body) määrake milliseid andmeid saata (kasutades nt  replace süntaksit)

Replace väärtuste kasutamine päringu sisus

Saate dünaamiliselt lisada andmeid muudetud objektist, kasutades formaati: REPLACE:fieldname

Näide: Artikli nime edastamine. 

Päringu sisu:

{

  “name”: “REPLACE:name”,

  “code”: “REPLACE:code”,

  “price”: “REPLACE:price”

}

Webhooki töötamisel, asendab süsteem REPLACE:name automaatselt selle artikli tegeliku nimega, mille kohta muudatus tehti

Saadaolevad väljad:

  • Väljade nimed vastavad ERPLY Booksi API dokumentatsiooni väljanimedele
  • Kontrollige API dokumentatsioonist iga tabeli täpset väljanimekirja