API
      Takaisin aloitussivulle
      1. Help Center
      2. Integraatiot
      3. API

      Zeffin Webhook-rajapinnan ymmärtäminen ja hyödyntäminen

      Tässä artikkelissa opit, kuinka voit hallita ja vastaanottaa Zeffistä tulevia ilmoituksia (webhookeja) aina, kun keskeisiä tapahtumia tapahtuu.

      Mikä on Zeffin Webhook-rajapinta?

      Zeffin Webhook-rajapinnan avulla voit automatisoida päivitykset järjestelmien välillä. Sen sijaan, että hakisit kysely- tai yhteystietoja toistuvasti, webhookit “työntävät” päivitykset haluttuun sovellukseen tai palveluun reaaliajassa.

      Tyypillisiä tapahtumia ovat esimerkiksi:

      • Yhteystiedot: Ilmoitus, kun yhteystieto luodaan tai päivitetään.
      • Vastaukset (Answers): Ilmoitus, kun vastaaja saa kyselyn valmiiksi.
      • Kutsut (Invitations): Ilmoitus, kun kyselykutsun tila muuttuu (esim. “sending” -> “delivered” tai “bounced”).

      Miksi käyttää Zeffin Webhook-rajapintaa?

      Reaaliaikaiset päivitykset:
      Saat välittömiä ilmoituksia tärkeistä muutoksista ilman jatkuvaa tietojen hakemista.

      Automaatio ja integraatiot:
      Voit yhdistää Zeffin muihin järjestelmiin (kuten CRM:ään, analytiikkatyökaluihin tai työnkulkuautomaatioihin) ja varmistaa, että tietosi pysyvät ajan tasalla. Tärkeät tapahtumat voivat näin käynnistää automaattisia toimenpiteitä.

      Mukautettava sisältö ja tietoturva:
      Voit rajata, mistä tapahtumista haluat ilmoituksia, määrittää mitkä kentät lähetetään sekä suojata webhook-kutsuja Basic Authentication -tunnuksilla tai mukautetuilla otsikkokentillä.

      Keskeiset ominaisuudet

      • Webhookien listaaminen:
        Saat listan kaikista organisaatioosi konfiguroiduista webhookeista. Näet, mihin osoitteisiin ilmoitukset lähetetään ja millaisista tapahtumista ne laukeavat.

      • Uusien webhookien luominen ja muokkaaminen:
        Voit luoda uusia tai päivittää olemassa olevia webhook-konfiguraatioita. Voit esimerkiksi:

        • Valita, mistä tapahtumatyypeistä (yhteystiedot, vastaukset, kutsut) ilmoituksia halutaan.
        • Määrittää URL-osoitteen, johon ilmoitukset lähetetään.
        • Lisätä autentikointitietoja ja mukautettuja HTTP-otsikoita integraatioiden suojaamiseksi.
        • Rajata tapahtumia tiettyihin kyselyihin, kutsuavaimiin tai kutsujen tiloihin.

      • Webhookien poistaminen:
        Kun et enää tarvitse tiettyä webhookia, voit poistaa sen estääksesi turhat ilmoitukset.

      • Webhook-vastausten esikatselu:
        Vastauksiin (answers) liittyville webhookeille voit esikatsella lähtevää dataa ennen käyttöönottoa. Näin varmistat, että vastaanottava järjestelmä saa juuri haluamaasi tietoa.

      Tuetut tapahtumatyypit

      1. Contacts (Yhteystiedot):
        Ilmoitus aina, kun yhteystietoa lisätään tai päivitetään Zeffissä.

      2. Answers (Vastaukset):
        Ilmoitus, kun vastaaja saa kyselyn valmiiksi. Voit käsitellä vastaukset heti.

      3. Invitations (Kutsut):
        Ilmoitus, kun kyselykutsun tila muuttuu (esim. “sending”, “delivered”, “bounced”). Näin voit reagoida esimerkiksi toimitusongelmiin välittömästi.

      Autentikointi ja tietoturva

      • API-avain tai OAuth2:
        Webhook-rajapinnan käyttäminen vaatii Zeffin API-avaimen tai OAuth2-tunnisteet.

        • API-avain: Luo avain Zeffin organisaatioasetuksissa.
        • OAuth2: Käytä client credentials -menetelmää, jos käytössäsi on tähän soveltuvat tunnisteet.

      • IP-rajaukset ja mTLS (Mutual TLS):
        Voit rajoittaa API-pyyntöjä IP-osoitteen perusteella tai käyttää kahdenvälistä TLS-varmennusta (mTLS). Jos käytät mTLS:ää, tarvitset silti myös API-avaimen.

      • Webhook-pyyntöjen suojaus:
        Voit suojata vastaanottopään (esim. oman palvelusi) Basic Authentication -tunnisteilla tai määrittää tietyt otsikkokentät varmistaaksesi, että ilmoitukset tulevat luotettavasta lähteestä.

      Käyttötapauksia

      • CRM-integraatio:
        Kun Zeffissä päivitetään yhteystietoja, vastaava tieto siirtyy automaattisesti CRM-järjestelmään.

      • Reaaliaikainen analytiikka:
        Heti kun kyselyn vastaus on valmis, data ohjataan analytiikka- tai raportointityökaluun.

      • Automaattiset hälytykset:
        Jos kutsun tila muuttuu “bounced”-tilaan, järjestelmä voi lähettää hälytyksen tiimillesi tai merkitä yhteystiedon jatkotoimenpiteitä varten.

      Aloittaminen

      1. Hanki API-tunnisteet:
        Siirry Zeffin organisaatioasetuksiin > Integraatiot ja hanki API-avaimesi tai OAuth2-asiakastunnisteet.

      2. Määritä webhook:
        Luo webhook rajapinnan avulla:

        • Valitse halutut tapahtumatyypit (esim. answers tai contacts).
        • Aseta webhookille kohde-URL.
        • Määritä tarvittavat rajaukset, suodattimet ja tietoturva-asetukset.

      3. Testaa ja varmista toimivuus:

        • Käytä esikatselutoimintoa (answers-tyypeille) tarkistaaksesi datan muoto.
        • Testaa tapahtuma Zeffissä (esim. päivitä yhteystieto) ja varmista, että palvelusi saa ilmoituksen oikein.

      4. Ota käyttöön:
        Kun olet tyytyväinen asetuksiin, ota webhook käyttöön tuotannossa ja hyödynnä reaaliaikaista tiedonsiirtoa.

      Lisäresurssit

      • Zeffin dokumentaatio:
        Tutustu laajempaan API-dokumentaatioon ja esimerkkeihin suoraan Zeffin integraatioasetuksissa.

      • Zeffin tuki:
        Jos tarvitset apua konfiguroinnissa tai ongelmien ratkaisemisessa, ota yhteyttä Zeffin tukeen.