Y API
Cha nel endpoint privaat ayn. Cha nel eh ayns ynnyd erbee, cha nel er son y interface.
Smoo products ta daa API: y fer documented t'eh currit dhyt, as y fer gennal ta ny screedsyn hene jeh ymmyd. Y fer nah t'eh dy bragh ny share, as cha nel oo dy bragh er ny chur er-ash er. Ayns shoh ta fer, as ta y interface client jeh gollrish red erbee elley — shen constraint orrin, as y fa ta ooilley red t'ou feme troggal ry-gheddyn.
Cre ta y rule shen costal dy firrinagh
T'eh çheet dy ghra dy vel screen keayrtyn feme fey er y API dy ve kiart, cha nel eh roshtish mygeayt er son un field so-yillagh. Y laa ta screen feme red nagh jargagh y API pobblagh cur rish, shen y laa ta y API kiart, as y fix she y API.
Y payoff she dy vel tree clients feer anchasleyley costal begnagh nhee elley. Y MCP server t'eh client. Dash-b tile t'eh client. Dty script hene t'eh client. Cha nel fer jeu second-class citizen gobbraghey mygeayt eaghtyr jeant er son fer elley, er-yn-oyr cha nel eaghtyr elley dy ve second to.
Documented, as exercised
OpenAPI t'eh gientit ec /docs as dy chooilley route ta test t'eh y example 'sy documentation. Documentation scruit dy scarrah veih y code drifts sthie un vee; documentation ta failley y build tra t'eh kiart, cha nel.
Sign ayn
Yn accoont castomo ayd, trooid y roie udjeyaght lesh PKCE — yn accoont cheddin t'ou jannoo ymmyd jeh son dash-b as y chooid elley jeh'n lught-thie. Ta duillag gyn freayllt eck cur y roie shen er bun dy mie; shen yn aght v'eh jeant. Son obbyr machine-gys-machine, oyrre API scoillit gys prowent.
- 1Pobble
/v1/contacts·/lists·/segments·/tags·/imports - 2Cooid
/v1/creatives, lesh kerrin, roish-akin as render er dagh targaid - 3Obbraghey-hene
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4Scaoilley-magh
/v1/campaigns, lesh co-hoyr, materialise, claare as choyrt myr stepyrgyn anchasley - 5Taghyrtyn stiagh
/v1/events— taghyrtyn yn applacaid ayd hene, myr troidalyn - 6Livreyrys
/sender-identities·/domains·/apps·/webhooks - 7Earrooyn
/v1/reports/*, as/track/*er y host trackal
OpenAPI ec /docs/mcp er yn un phroceed
Cliaghtaghyn
Yn cummey cheddin as dagh shirveish castomo elley
Shen scanshey ny smoo na t'eh sheean. My t'ou foast gyllagh fer jeu, sheoin dhyt foast kys ta shoh freggyrt, doyrt as paginat.
Un phoagey marragh
Ta dagh doyrt jannoo ymmyd jeh'n cummey cheddin, coad shickyr as chaghteraght jeant son pheiagh. Cha nel raad erbee croo e aght hene dy ve neayr.
Paginat lesh cursor
Cha nel offsets. Ta rolley caghlaa tra t'ou shooyl eh cha nel eh gimman ny aachroo rheynnyn dy folliaght, ny ta paginat offset jannoo dy folliaght as dy kinjagh.
Oyrreyn idempotency
Er dagh raad caghlaa. Aa-yeearragh earish nagh vel shiu shickyr haink eh gys y cheilley as gow yn freggyrt cheddin, cha nel contact nah, campaign nah ny choyrt nah.
Scoillit gys prowent
Ta token cur-my-ner un tenant as un prowent, y daa. Ta seyr-chaddey row-level er ny yannoo ayns y stoyr-data hene, cha nel liorish cooinaghtyn dy chur clause.
Webhooks magh
Signit, aa-rynsit lesh backoff, as livrit cooidjagh un cheayrt — myr shen yn endpoint ayd by ioor idempotent neesht. Ta ny taghyrtyn jannoo ymmyd jeh'n cheshaght-ghoo cheddin as ny reportyn.
Spooilley as assynee
Ta contact so-yantit dy assynee ny spooilley trooid yn API, as ta spooilley roshtyn dagh shirveish vraar-ny-hraie va cummal coip trooid lane sthie yn lught-thie hene.
Ta POST so-yantit jannoo ooilley ny ta'n interface so-yantit.
Ta taghyrtyn yn ayrn anaasoil
Ta ooilley elley er y duillag shoh plumbing va shiu jerkal rish. Ta POST /v1/events yn raad caghlaa cre son ta'n prodott.
Ta'n applacaid ayd foast toiggal reddyn nagh vel greie vargaght erbee so-akin: quoi ren cronnaghey onboarding, quoi ren cuirrey co-obbrinagh, quoi ren roshtyn kione, quoi ren assynee nyn data Jelune fastyr. Post ad shen myr taghyrtyn lesh yn token ayd hene, as ta dagh fer jeant myr troidal, cooish as segment.
Ta'n chooid elley geiyrt er y chummey contact. Ta taghyrtyn currit rish, cha nel ad er ny chaghlaa rie; t'ad yn log ta'n prodott slane croghaney er. Cha nel funnel cur er bun taghyrt va shiu meenit myr integrazione — t'eh yn aght cheddin as message_opened ta jannoo ymmyd jeh, lesh ennym anchasley ayn.
- 1T'ou postal eh
POST /v1/events— ennym, contact, payload, oyrre idempotency. - 2T'eh roshtynCurrit rish log y contact. Cha vel red erbee elley feme toiggal dy vel eh ayn.
- 3Ta funnel goll er bunErbee funnel ta enmyssyn y taghyrt shen 'sy chied gholl, er son contact erbee ta jeean fo y chied-spec echey.
- 4Funnels elley branagh er"Vel y taghyrt shen er ghraill ayns ny 14 laghyn s'jerree" she predicaid segment cadjin eh.
- iAs t'eh cur jerrey er runsNode oik ta enmyssyn y taghyrt cheddai, t'eh cur stayd da sequence yn traa t'yn pheiagh jannoo y red.
Y vocabulary euY token eu
Joaraghyn ta feeu dy hoiggal roish my t'ou troggal
Ta ClickSomo cur sheese three enmyssyn mychione diu — tenant, project as user, myr ids opaque — as nothing elley. Cha nel password, cha nel profile, cha nel card, cha nel invoice. Ta cagliaghyn y plan çheet myr earrooyn: quig contacts, quig sends, quig generations. Cha nel vocabulary eeckaghyn tarragh yn linney shen er dagh çheu.
Ta ny contacts eu eu hene. She shiu yn data controller; shinyn yn processor. Cha nel raad erbee liorish y vee ta product elley 'sy lught lhaih ny screeu yn rolley contacts eu, as cha nel ingest-lane son fer jeh ymmyd.
My t'ou toiggal y red shoh dy dainearagh: lhaih /docs roish my lhaih tooilley jeh'n ynnyd-eggey shoh. She yn API y choyrle onestagh er ny ta'n product jannoo, as ta dagh aggle er ny duillagyn shoh çheet gys raad ny gys kin node ta shiu feddyn ayns shen. Tra ta'n schema caghlaa, ta ny duillagyn shoh caghlaa.