Siirry sisältöön

Tapahtumaluettelo

Hyötykuorman muoto

Osio nimeltä “Hyötykuorman muoto”

Jokainen tapahtuma on yksi JSON-objekti:

{
  "id": "evt_01HKQN9…",
  "type": "conversation.created",
  "occurred_at": "2026-04-20T14:23:45.123Z",
  "account_id": "7c1d2c6e-…",
  "site_id": "0f3a…",
  "data": { … the resource, in the same shape the API returns it … }
}

id on X-RolChat-Event-Id-otsakkeen arvo, ja se pysyy samana uusintayrityksissä. type on muotoa <domain>.<noun>.<verb> tai <domain>.<verb> snake_case-kirjoitusasulla. data sisältää resurssin sellaisena kuin vastaava GET-päätepiste sen palauttaisi, joten vastaanottimen voi kirjoittaa API-viitteen pohjalta eikä toista skeemaa koskaan tarvita.

Tapahtumaperheet

Osio nimeltä “Tapahtumaperheet”
Perhe Esimerkkejä Lähetetään, kun
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Keskustelun tila tai omistaja muuttuu
message.* message.created, message.delivered, message.read, message.failed Viesti lähetetään tai sen toimitustila muuttuu
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Liidi, kontakti, yritys tai kauppa muuttuu
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Tiketti muuttuu
visitor.* visitor.identified, visitor.cobrowse.requested Vierailija tunnistetaan tai hän pyytää yhteisselausistuntoa
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Lomakkeet, varaukset, kampanjat
kb.* kb.article.published, kb.article.unpublished Tietopankin muutokset
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Puhelut ja vastaajaviestit
automation.* automation.rule.executed, automation.rule.failed Automaatiosääntö suoritetaan
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Suostumus ja rekisteröityjen pyynnöt
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Tilaus ja laskut
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Tietoturvan kannalta merkittävät tilitapahtumat
ai.* ai.usage.recorded Jokainen AI-adapterin kutsu tokenimäärineen

Tarkka luettelo kasvaa tuotteen mukana; tilausnäkymä näyttää jokaisen tyypin, jonka tilisi voi vastaanottaa, ja antaa suodattaa tyypeittäin.

Tilaaminen

Osio nimeltä “Tilaaminen”

Webhook-tilaukset kuuluvat laajennukselle. Avaa kohdassa Asetukset → Laajennukset laajennus (tai luo mukautettu) ja lisää päätepiste: HTTPS-osoite, haluamasi tapahtumatyypit ja valinnainen IP-sallittujen luettelo. Allekirjoitussalaisuus näytetään kerran. Kyseisen päätepisteen toimitukset, uusintayritykset ja kuolleet kirjeet näkyvät laajennuksen Webhook-lokissa.

Laajennukset-sivun Plugin Protocol kuvaa, miten laajennus ilmoittaa tarvitsemansa tapahtumat manifestissaan.

Järjestys ja toimitus

Osio nimeltä “Järjestys ja toimitus”
  • Toimitus tapahtuu vähintään kerran. Poista kaksoiskappaleet id-arvon perusteella.
  • Yhden resurssin tapahtumat lähetetään järjestyksessä, mutta uusintayritykset voivat muuttaa toimitusten järjestystä. Käytä occurred_at-arvoa ja resurssin updated_at-arvoa saapumisajan sijaan.
  • Jatkuvasti epäonnistuva tilaus kerryttää kuolleita kirjeitä; yli 100 yhdelle päätepisteelle nostaa hälytyksen RolChatin puolella ja näyttää varoituksen laajennuksen lokissa.