Meta tags:
description= Learn about Customer.io s Reporting Webhooks to receive real-time notifications about message delivery, opens, clicks, and more.;
Headings (most frequently used words):
api, webhooks, reporting, customer, io, reference, set, up, timeouts, and, failures, securely, verifying, requests, download, the, openapi, spec, for, this, all, specifications, ai, agent, friendly, resources, models, webhook, format,
Text of the page (most frequently used words):
app (80), and (79), push (78), messages (78), the (73), your (56), events (54), #customer (45), started (44), set (42), people (42), track (41), data (40), notifications (38), email (34), for (33), with (33), webhook (31), api (30), get (30), identify (29), metrics (28), message (27), troubleshooting (26), event (22), webhooks (22), use (22), send (21), how (21), tracking (21), from (19), links (19), mobile (17), changelog (17), getting (17), you (16), account (16), create (16), anonymous (16), campaigns (16), test (15), timestamp (15), start (15), integrations (14), multiple (14), subscription (13), reporting (13), activity (13), listeners (13), deep (13), what (13), campaign (13), content (12), options (12), custom (12), quick (12), guide (12), inbox (12), google (12), objects (12), json (11), this (11), using (11), page (11), add (11), users (11), authentication (11), manage (11), capture (11), journeys (11), update (10), inline (10), android (10), channels (10), screen (10), lifecycle (10), segments (10), request (9), body (9), link (9), version (9), edit (9), handling (9), providers (9), new (9), configuration (9), works (9), migrate (9), advanced (9), editor (9), transactional (9), copy (8), sms (8), triggered (8), security (8), introduction (8), reference (8), privacy (8), notification (8), liquid (8), emails (8), example (7), required (7), type (7), format (7), sent (7), cio (7), integration (7), our (7), time (7), flutter (7), packages (7), forms (7), components (7), subscribed (6), attributes (6), when (6), whatsapp (6), can (6), string (6), url (6), server (6), addresses (6), out (6), service (6), ios (6), react (6), native (6), support (6), design (6), studio (6), pipelines (6), amazon (6), javascript (6), inbound (6), conditions (6), select (5), metric (5), about (5), change (5), key (5), signature (5), analysis (5), segment (5), workspace (5), best (5), practices (5), billing (5), updates (5), location (5), earlier (5), rules (5), frequently (5), asked (5), questions (5), legacy (5), hubspot (5), actions (5), code (5), overview (5), syntax (5), welcome (5), css (5), sending (5), broadcasts (5), workflows (5), object_type (4), slack (4), that (4), attribute (4), one (4), signing (4), hash (4), requests (4), number (4), form (4), standard (4), find (4), settings (4), endpoint (4), via (4), failed (4), call (4), receive (4), open (4), builder (4), agent (4), understand (4), workspaces (4), features (4), groups (4), rich (4), messaging (4), apis (4), conversions (4), snowflake (4), storage (4), bigquery (4), redshift (4), based (4), understanding (4), tests (4), recipes (4), statuses (4), preferences (4), global (4), component (4), faq (4), styles (4), opt (4), layouts (4), domain (4), delete (4), branches (4), filters (4), style (4), relationships (4), post (3), information (3), specific (3), object (3), unix (3), person (3), their (3), hmac (3), sha256 (3), verify (3), headers (3), all (3), client (3), validate (3), header (3), have (3), issues (3), want (3), servers (3), retry (3), calls (3), until (3), successful (3), response (3), enable (3), they (3), https (3), openapi (3), group (3), docs (3), mcp (3), beta (3), conversion (3), assign (3), roles (3), performance (3), upgrade (3), expo (3), implementation (3), certificates (3), visual (3), website (3), twilio (3), salesforce (3), mixpanel (3), facebook (3), ads (3), cohorts (3), triggers (3), map (3), reverse (3), etl (3), policy (3), live (3), common (3), deliverability (3), broadcast (3), goals (3), errors (3), personalize (3), files (3), center (3), multi (3), templates (3), surveys (3), trigger (3), web (3), phone (3), integrate (3), preview (3), drag (3), drop (3), smtp (3), types (3), workflow (3), why (3), export (3), csv (3), show (2), more (2), models (2), com (2), 1613063089 (2), 01e4c4ct6ydc7y5m7fe1gwwpqj (2), event_id (2), integer (2), values (2), channel (2), enum (2), whether (2), unsubscribed (2), was (2), false (2), unsubscribes (2), combining (2), help (2), securely (2), following (2), action (2), etc (2), shell (2), python (2), node (2), first (2), need (2), value (2), purposes (2), every (2), same (2), where (2), enter (2), error (2), responses (2), connection (2), connect (2), codes (2), status (2), wait (2), timeouts (2), exponential (2), backoff (2), backlog (2), subsequent (2), returns (2), don (2), period (2), seven (2), days (2), processing (2), click (2), happen (2), frequency (2), http (2), recommended (2), log (2), external (2), method (2), close (2), documentation (2), survey (2), suggestions (2), other (2), setup (2), accounts (2), cli (2), feedback (2), browser (2), store (2), cookies (2), expiration (2), search (2), single (2), two (2), team (2), members (2), plan (2), tasks (2), logs (2), verification (2), provisional (2), sound (2), sdks (2), html (2), comparing (2), pixel (2), sendgrid (2), rudderstack (2), azure (2), blob (2), cloud (2), audiences (2), braze (2), amplitude (2), connections (2), past (2), mode (2), classic (2), deleting (2), services (2), postgresql (2), mysql (2), microsoft (2), sql (2), filter (2), incoming (2), csp (2), proxying (2), another (2), disconnect (2), backend (2), lead (2), video (2), semantic (2), compliance (2), results (2), dashboard (2), personalization (2), library (2), brand (2), adding (2), parameters (2), localization (2), line (2), activities (2), respond (2), feature (2), adoption (2), upcoming (2), promotions (2), nps (2), display (2), flow (2), build (2), sender (2), senders (2), adapting (2), template (2), resources (2), relay (2), zone (2), reusable (2), exit (2), batch (2), llm (2), concepts (2), newsletters (2), reminders (2), trial (2), book (2), frequencies (2), aren (2), collaborate (2), automation (2), connected (2), shortcuts (2), devices (2), work (2), segmentation (2), collections (2), import (2), non (2), index (2), make (2), releases (2), friendly (2), d9c106000001, cio_id, identifiers, email_address, 0200000001, customer_id, reportingwebhook, child, contains, occurred, webhook_timestamp, _app, wasn, determine, which, _type, unique, being, _id, recorded, explicitly, const, occur, subscribes, application, used, sends, are, generally, organized, representing, pertaining, bounced, curl, clients, php, ruby, libraries, signed, retrieve, combine, delimited, colons, always, secret, compare, confirm, originated, delivered, generated, verifying, temporarily, block, look, current, tls, certificate, x509, read, reset, peer, refused, misbehaving, eof, 521, 502, 500, 429, 410, 405, 404, 403, 402, 401, 400, responds, any, hour, before, retries, second, timeout, 2xx, during, those, seconds, over, won, continue, them, timed, day, expires, failures, save, include, determines, optional, either, but, protect, inform, notify, immediately, lets, subscribe, details, report, back, menu, powered, scalar, loading, release, notes, cursor, ides, claude, chatgpt, command, routines, skills, ask, har, file, login, qualifications, respecting, gdpr, allowlist, session, case, sensitivity, timezone, experimental, regions, sign, sso, factor, credentials, customize, switch, between, canceling, payment, problems, reducing, overages, credits, bill, audit, sdk, swift, zendesk, yandex, wisepops, optimizer, vwo, twitter, engage, tiktok, talon, sprig, marketing, saleswings, ripe, qualtrics, playerzero, pipedrive, pinterest, moengage, metronome, meta, logrocket, livelike, launchdarkly, koala, intercom, heap, tag, manager, gtm, sheets, analytics, gtag, gainsight, fullstory, friendbuy, criteo, cordial, commandbar, clevertap, bing, attio, algolia, insights, adobe, target, actable, predictive, resend, filtering, mapping, database, warehouse, zoho, zapier, mparticle, platforms, calculator, scheduled, syncs, invalid, transform, utility, methods, identity, management, managing, identities, frameworks, wordpress, wpforms, webflow, unbounce, typeform, squarespace, jotform, formstack, sources, backfill, historical, playback, chat, ecommerce, fields, alias, source, specs, directory, attempted, conclusive, reports, home, composer, reusing, snippets, list, deliveries, drafts, image, requirements, assets, outside, language, preference, faqs, pages, universal, checking, translations, translate, languages, milestones, achievements, promote, offers, localize, step, compose, hipaa, regulations, kind, registration, compliant, register, numbers, keyword, smart, character, encoding, keywords, shortening, mms, payloads, registering, device, tokens, provider, trustpilot, reviews, gmail, does, fake, bcc, option, preheader, text, avatar, logo, mailchimp, column, foundation, basic, view, amp, pre, archive, customizing, basics, choose, right, editors, oracle, dyn, sparkpost, postmark, mandrill, mailjet, mailgun, own, deliverable, kickbox, anonymized, authenticating, apple, private, unsubscribe, rfc, 8058, postmaster, tools, suppression, lists, suppressions, spamhaus, blocklist, listings, shared, dedicated, warming, attachments, creating, transitioning, limits, supported, formats, zones, geolocation, queue, draft, behavior, default, direct, mail, lob, configure, randomized, delay, window, delays, blocks, true, random, split, control, reformat, fix, inconsistent, names, journey, items, holdout, generate, decisions, examples, inactive, trips, rss, feed, cohort, optimize, just, words, onboarding, double, cart, abandonment, birthday, anniversary, recipe, grace, periods, tickets, syncing, sync, customers, stripe, follow, receiving, entering, troubleshoot, state, schedule, criteria, tags, history, submit, teammates, parcel, stylesheet, loop, through, conditionals, directives, modifiable, placeholder, scratch, publish, changes, mso, emmet, accessibility, fixes, variables, cleanup, formatting, inlining, mjml, framework, transformers, individual, responsive, dark, keyboard, review, convert, setting, match, within, building, manual, driven, activate, waitlist, awareness, announce, drive, usage, upsell, monetize, power, cases, tutorials, merging, know, available, storing, suppress, profile, ids, last, visited, field, resolve, duplicate, profiles, academy, structured, learning, demo, llms, txt, specifications, access, raw, specification, directly, download, spec, requires, render, interactive,
Text of the page (random words):
omer io map data to other services scheduled syncs deleting data api call calculator servers node js python go customer data platforms segment segment data in classic rudderstack mparticle legacy webhook based integrations using zapier with the track api zoho integration hubspot integration data out getting started add a data out integration actions action triggers code mode database warehouse integrations introduction standard integrations advanced integrations filtering and mapping actions resend past data connections actable predictive adobe target algolia insights amazon redshift amazon redshift advanced amazon s3 amazon s3 advanced amplitude amplitude message metrics attio azure blob storage bing ads braze braze cohorts clevertap close commandbar cordial criteo audiences customer io facebook conversions api friendbuy fullstory gainsight px google ad conversions google ads gtag google analytics google bigquery google bigquery advanced google cloud storage google cloud storage advanced google sheets google tag manager gtm heap hubspot intercom koala launchdarkly livelike logrocket meta facebook pixel metronome mixpanel mixpanel message metrics moengage ms azure blob storage advanced pinterest conversions pipedrive playerzero qualtrics reporting webhooks ripe rudderstack legacy salesforce about this integration sent messages as tasks frequently asked questions saleswings segment segment message metrics sendgrid marketing campaigns slack snowflake snowflake advanced sprig talon one tiktok conversions twilio twilio engage messaging twilio studio twitter pixel visual website optimizer vwo webhooks wisepops yandex zendesk api reference about our apis comparing the pipelines and track apis pipelines api track api app api design studio html best practices journeys webhooks mobile sdks ios quick start guide getting started how it works authentication packages and configuration options swift 6 troubleshooting identify and track users identify people track events screen tracking mobile lifecycle events anonymous activity location tracking push notifications set up push notifications set up rich push app groups for push tracking deep links push metrics sound in push notifications provisional push push service certificates test your push implementation in app messages set up in app messaging inline in app messages page rules in app event listeners notification inbox what s new 4 x 4 4 0 3 x 4 0 0 3 x 3 13 0 3 x 3 9 0 2 x 3 x 1x 2 x changelog ios quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify people track events screen tracking mobile lifecycle events anonymous activity push notifications set up push notifications set up rich push deep links push metrics sound in push notifications provisional push push service certificates test your push implementation in app messages set up in app messaging inline in app messages page rules in app event listeners what s new 3 x 3 13 0 3 x 3 9 0 2 x 3 x 1x 2 x changelog ios get started identify people track events push notifications rich push notifications in app messages test support changelog ios get started identify people track events push notifications in app messages test support update from 2 10 to 2 11 migrate from an earlier version troubleshooting changelog android quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify people screen tracking mobile lifecycle events anonymous activity track events location tracking push notifications push notifications deep links channel push service certificates test your push implementation in app messages in app messages in app event listeners inline in app messages page rules notification inbox what s new 4 x 4 10 3 x 4 x 2 x 3 x changelog android get started identify people track events push notifications in app messages test support migrate from an earlier version troubleshooting changelog android get started identify people track events push notifications rich push notifications test support migrate from an earlier version changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify people track events screen tracking mobile lifecycle events anonymous activity location tracking push notifications set up push notifications app groups for push tracking deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners notification inbox what s new 6 x 6 4 0 5 x 6 0 0 4 x 5 0 0 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify people track events screen tracking mobile lifecycle events anonymous activity push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners what s new 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify people track events screen tracking mobile lifecycle events anonymous activity push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners what s new 4 x 5 0 0 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native get started identify people track events push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting migrate from an earlier version troubleshooting changelog react native get started identify people track events push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting migrate from an earlier version update to version 3 4 troubleshooting changelog expo quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track people identify people track events screen tracking mobile lifecycle events anonymous activity location tracking push notifications set up push notifications app groups for push tracking deep links capture push metrics android channels multiple push providers in app messages inline in app messages notification inbox set up in app messages in app event listeners what s new 3 x 3 3 2 x 3 x 1x 2 x changelog expo get started identify people track events push notifications set up push notifications deep links capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting troubleshooting changelog flutter quick start guide get started how it works authentication configuration options troubleshooting identify track users identify people mobile lifecycle events anonymous activity screen tracking track events location tracking push notifications set up push notifications app groups for push tracking deep links handling multiple push providers capture push metrics android channels in app messages in app messages inline in app messages notification inbox in app event listeners what s new 3 x 4 0 0 3 x 3 5 0 2 x 3 0 0 2 x 2 2 upgrade to flutter 2 x changelog flutter quick start guide get started how it works authentication configuration options troubleshooting identify track users identify people mobile lifecycle events anonymous activity screen tracking track events push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages in app messages inline in app messages in app event listeners what s new 2 x 2 2 upgrade to flutter 2 x changelog flutter get started identify people track events update flutter sdk push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages in app messages in app event listeners updates and troubleshooting update ios troubleshooting changelog account workspaces account verification audit logs tasks workspace performance billing how we bill billing for sms messages billing for whatsapp messages ai credits reducing billing overages payment problems canceling your account plan features builder plan your account manage team members how to add team members assign standard roles create assign custom roles switch between accounts edit account information customize your ui manage your api credentials security best practices two factor authentication single sign on sso account regions us and eu enable experimental features workspaces workspaces in customer io understand timezone conversion case sensitivity and your data search your workspace privacy security session cookies and expiration allowlist our ip addresses customer io gdpr and you security mobile and app store privacy privacy respecting your users privacy ai settings customer io security qualifications troubleshooting troubleshooting login and browser issues create a har file for help troubleshooting ai use customer io with ai your customer io agent beta ask the agent custom skills routines segment builder troubleshooting and feedback customer io cli get started service accounts command reference customer io mcp get started chatgpt setup claude setup cursor and other ides update your mcp client email content analysis in app message suggestions in app survey analysis use our docs with ai release notes loading api documentation introduction open introduction webhooks close group reporting webhook format http method post models open group powered by scalar open menu v1 0 0 openapi 3 1 0 reporting webhooks customer io lets you subscribe to reporting webhooks this page details the events that we report back to your webhook url set up webhooks to inform an external service about customer io events webhooks can notify you immediately when customer attributes change or when people open your messages set up webhooks log in and go to data integrations integrations find and select reporting webhooks click add reporting webhook enter the webhook endpoint the url where you want to receive events the url can be either http or https but we recommended https to protect customer information select the events you want to receive optional select the send frequency and body content options send frequency this determines whether you receive events the first time they happen or every time they happen body content enable this to include message body content in all of the sent events we send to you click save and enable webhook timeouts and failures we have a 4 second timeout for calls to your webhook endpoint if we don t get a successful 2xx response during those 4 seconds we retry the webhook over a period of seven days with an exponential backoff we backlog subsequent webhook calls and won t continue processing them until the timed out webhook call returns a successful response or the seven day retry period expires if your webhook server responds with any of the following status codes we ll wait for one hour before we retry the failed call as with timeouts we use the same exponential backoff for retries and we ll backlog subsequent webhook calls until the failed call returns a successful response error codes 400 401 402 403 404 405 410 429 500 502 521 error responses eof server misbehaving connect connection refused read connection reset by peer tls failed to verify certificate x509 if you have issues with your webhook server and you want to temporarily block our servers you can look up the current set of ip addresses we use via this api endpoint securely verifying requests for security purposes every email webhook is delivered with an x cio signature header this signature is generated by combining your webhook signing key with the body of webhook request using a standard hmac sha256 hash you can find the signing key on the email activity webhook integration page in your account settings this is the same page where you enter your webhook endpoint to validate a signed request first you ll need to retrieve the x cio timestamp header sent with the webhook request and the body of the request combine the version number timestamp and body delimited by colons to form a string in the form v0 timestamp body the version number is always v0 using hmac sha256 hash the string using your webhook signing secret as the hash key compare this value to the value of the x cio signature header sent with the request to confirm that the request originated with customer io client libraries shell ruby node js php python more select from all clients shell curl webhooks copy link webhooks webhooks post reporting webhook format webhook reporting webhook format copy link customer io sends events to your webhook url in the following format events are generally organized by object_type representing the message or customer io action i e email sms etc and the specific metric pertaining to the type i e sent bounced etc headers x cio timestamp copy link to x cio timestamp type integer format unix timestamp required the timestamp when the request was sent x cio signature copy link to x cio signature type string required a string combining your webhook signing key with the body of webhook request using an hmac sha256 hash used to help you securely verify requests body application json one of customer events that occur when a customer subscribes or unsubscribes from your messages one of customer subscribed a person subscribed to messages from you their unsubscribed attribute was set to false metric enum const subscribed required the metric recorded by the event for customer events this is whether the customer explicitly subscribed or unsubscribed values subscribed event _id type string event_id required example 01e4c4ct6ydc7y5m7fe1gwwpqj the unique id of the reporting webhook event being sent object _type type string enum required example customer the channel that triggered the subscription change if the subscription change wasn t triggered from a message or we can t determine which message triggered the change the object_type is customer values customer email sms push in _app slack webhook whatsapp timestamp type integer webhook_timestamp format unix timestamp required example 1613063089 the unix timestamp when the event occurred data type object required contains information about the event specific to the object_type and metric show child attributes for data reques...
|
