CLItrail Docs

Webhook event types

Every webhook body has the same envelope. Signing is described on Webhooks.

TypeSent when
cli.install_completedAn installation reported install_completed. Once per installation.
cli.first_runAn installation reported first_run. Once per installation.
cli.install_startedAn installation reported install_started, when you selected that event. Once per installation. Webhooks are the only destination for it.
test.pingYou chose Send test. data is empty and id starts with clt_test_.

#Envelope

FieldDescription
idStable event ID, also sent as webhook-id: clt_ and 40 hex characters.
typeOne of the types above.
timestampWhen the install was recorded, ISO 8601.
data.website_idYour website ID.
data.event_idThe event ID the hook sent.
data.installationSHA-256 of a pseudonymous installation ID. Stable across events from one installation.
data.install_pathThe install path ID the install counted toward.
data.attribution.resolutionmatched, ambiguous, unmatched or probable.
data.attribution.methodreceipt, handoff, reconstructed, or null when nothing was found. Installs matched by the network matching of earlier versions say network.
data.attribution.confidencehigh or medium for reconstructed installs, otherwise null.
data.attribution.policyThe website's attribution policy.
data.attribution.unattributed_reasonsafari or external when nothing matched; see Unattributed installs. Otherwise null.
data.attribution.signalsReconstructed installs only: each signal compared, as { signal, points, match, detail }. See Reconstruction.
data.attribution.touchThe credited visit, or null.
data.attribution.journeyEvery visit found, with the earlier visits its revisits replaced, oldest first. Empty when unmatched.

#Touch

FieldDescription
page_urlThe page visited, origin and path.
referrerThe page's referrer, origin and path, or null.
source_referrerThe external referrer where the session began, or null.
channelThe channel.
utmThe session's UTM values, or null.
visited_atWhen the visit was recorded, ISO 8601.
gpctrue when the visit was made with Global Privacy Control.
identifiersOnly with Include captured identifiers: { ga4, google_ads, meta, tiktok, x, custom } as captured.