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.escalated`	Vestlus eskaleeritakse
`lead.captured`	Püütakse uus liid
`lead.created`	Luuakse liidi kirje
`lead_form.submitted`	Esitatakse liidivorm
`handoff.requested`	Taotletakse üleandmist inimagendile
`csat.submitted`	Esitatakse CSAT-hinnang
`csat.received`	Salvestatakse CSAT-tulemus
`ai.failed`	Tehisintellekt ei suuda vastust koostada
`ticket.created`	Avatakse tugipilet
`ticket.resolved`	Tugipilet lahendatakse
`contact.created`	Luuakse uus kontakt
`contact.updated`	Kontakti uuendatakse
`contact.merged`	Kaks kontakti liidetakse
`contact.deleted`	Kontakt kustutatakse

Webhooki vorm pakub ka valikut Kõik sündmused, mis tellib kõik ülalolevad sündmused (salvestatakse metamärgina *); üks webhook võtab vastu ka komadega eraldatud sündmusenimede loendi.

Seadistamine

Avage Dashboard -> Arendajad -> Veebihaagid.
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-Webhook-Signature: t=<unix_timestamp>,v1=<hex_digest>
X-Webhook-Event: <event_name>
X-Webhook-Retry: <attempt>          # only on a retried delivery

Räsi arvutatakse <unix_timestamp>.<päringu_toorkeha> põhjal, seega ainult keha kontrollimine ei lange kunagi kokku. Tükelda päis , järgi, loe välja t= ja v1= väärtused, arvuta t + '.' + rawBody HMAC-SHA256 oma webhook secret'iga uuesti ja võrdle mõlemat räsi konstantses ajas. Lükka tagasi saadetised, mille ajatempel on vanem kui mõni minut, et püütud päringut ei saaks korrata. Märkus: Saada test URL-ile, mis ei ole salvestatud webhook, saadetakse allkirjata — puudub saladus, millega allkirjastada; testi oma kontrolli salvestatud lõpp-punkti vastu.

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 -> Arendajad -> API võtmed -> Loo API-võti.
Lisage see Authorization päisesse:

Authorization: Bearer sk_your_api_key_here

> Võtit näidatakse ainult üks kord. Võtme loomiseks tuleb valida vähemalt üks skoop — Loo püsib väljalülitatud, kuni valiku teed — ja täielik sk_ väärtus kuvatakse ainsat korda dialoogis, mis teadlikult ei sulgu Escape'i ega taustaklõpsuga. Pärast seda jääb loetavaks üksnes eesliide; ülejäänu on bcrypt-räsi ja seda ei saa taastada. Kopeeri võti enne dialoogi sulgemist. Kui kaotad selle, loo uus võti ja tühista vana.

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.