Webhookid ja REST API

Conviro pakub webhooke sündmustest reaalajas teavitamiseks ja REST API-t programmiliseks juurdepääsuks kõigile platvormi funktsioonidele.

Webhookid

Mis on webhookid?

Webhookid saadavad teie serverisse HTTP POST-päringu iga kord, kui Conviros toimub kindel sündmus. Nii saate reageerida reaalajas, ilma pidevalt pärimata (polling).

Saadaolevad sündmused

Sündmus	Käivitub, kui
`message.new`	Saadetakse uus sõnum (külastaja või boti poolt)
`session.started`	Algab uus vestlusseanss
`session.closed`	Vestlus suletakse
`session.handoff`	Vestlus antakse üle inimagendile
`lead.captured`	Salvestatakse uus müügivihje
`contact.created`	Luuakse uus kontakt
`ticket.created`	Avatakse kasutajatoe pilet
`csat.submitted`	Esitatakse CSAT-hinnang

Seadistamine

Avage Dashboard -> Settings -> Webhooks.
Klõpsake Add Webhook.
Sisestage oma lõpp-punkti URL (peab olema HTTPS).
Valige sündmused, mida soovite vastu võtta.
Klõpsake Save.

Turvalisus: HMAC-SHA256 allkirjastamine

Iga webhooki andmepakett allkirjastatakse HMAC-SHA256-ga, kasutades teie webhooki salavõtit. Autentsuse tagamiseks kontrollige allkirja oma serveris:

X-Conviro-Signature: sha256=<hex_digest>

Võrrelge seda päist toorpäringu keha HMAC-SHA256 räsiga, mille arvutate oma webhooki salavõtmega.

Korduskatsete reeglid

Kui teie lõpp-punkt tagastab olekukoodi, mis ei ole 2xx, proovib Conviro kuni 3 korda uuesti, kasutades eksponentsiaalset ooteaega (1 min, 5 min, 30 min).

REST API

Autentimine

Looge API võti asukohas Dashboard -> Settings -> API Keys -> Create Key.
Lisage see Authorization päisesse:

Authorization: Bearer sk_your_api_key_here

Peamised lõpp-punktid

Meetod	Lõpp-punkt	Kirjeldus
GET	`/api/chatbots`	Loetleb kõik chatbotid
GET	`/api/chatbots/:id`	Toob chatboti üksikasjad
GET	`/api/sessions`	Loetleb seansid (koos filtritega)
GET	`/api/sessions/:id/messages`	Toob seansi sõnumid
POST	`/api/sessions/:id/messages`	Saadab seanssi sõnumi
GET	`/api/contacts`	Loetleb kontaktid
POST	`/api/contacts`	Loob kontakti
GET	`/api/leads`	Loetleb müügivihjed
POST	`/api/leads`	Loob müügivihje
GET	`/api/analytics/overview`	Toob analüütika kokkuvõtte

Päringupiirangud

Free plaan: 60 päringut minutis
Starter: 120 päringut minutis
Pro: 300 päringut minutis
Growth+: 600 päringut minutis

Päringupiirangu päised lisatakse igale vastusele:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1672531200

Täielik dokumentatsioon

Täieliku API viite koos päringute ja vastuste näidetega leiate aadressilt /developers.