Oblic

ఈవెంట్‌లు

మీ సిస్టమ్‌లలో కాంటాక్ట్‌లు చేసే చర్యలను పంపండి: ఆర్డర్ ఇవ్వడం లేదా చెల్లించడం, కార్ట్ వదలడం లేదా ఉత్పత్తిని చూడడం. ప్రతి ఈవెంట్ ఒక్కసారి భద్రపడి, సంస్థ డిఫాల్ట్ వర్క్‌స్పేస్‌లో ఇమెయిల్ లేదా ఫోన్ ద్వారా కాంటాక్ట్‌తో సరిపోల్చి టైమ్‌లైన్‌లో చూపబడుతుంది. ఈ రూట్‌కు events:write ఉన్న కీ అవసరం; స్కోప్‌లు రాకముందు సృష్టించిన కీలకు అది లేదు.


POST/external/v1/events

ఈవెంట్‌లను నమోదు చేయడం

బాడీలో events అనే 1 నుంచి 100 ఈవెంట్‌ల అరే ఉంటుంది. ఏదైనా భద్రపరిచే ముందు అన్నింటినీ తనిఖీ చేస్తారు: ఒక్కటి తిరస్కరించినా మొత్తం అభ్యర్థన తిరస్కరించి ఏదీ భద్రపరచరు.

  • పేరు
    id
    టైప్ చేయండి
    string
    వివరణ

    అవసరం: ఈవెంట్‌కు మీ సొంత గుర్తింపు, ఖాళీలు లేకుండా 1 నుంచి 128 అక్షరాలు, ఉదా. order-1001-paid. అదే గుర్తింపుతో మళ్లీ పంపిన ఈవెంట్ ఒక్కసారే భద్రపడుతుంది, కాబట్టి నకలు లేకుండా అభ్యర్థనను మళ్లీ ప్రయత్నించవచ్చు.

  • పేరు
    type
    టైప్ చేయండి
    string
    వివరణ

    అవసరం: ఏమి జరిగిందో క్రింది రకాల్లో ఒకటిగా ఇవ్వండి.

  • పేరు
    occurredAt
    టైప్ చేయండి
    string
    వివరణ

    అవసరం: జరిగిన సమయం ISO 8601లో, ఉదా. 2026-10-20T10:00:00Z. ప్రస్తుత సమయంతో పోలిస్తే గరిష్ఠంగా ఐదు నిమిషాలు భవిష్యత్తులో లేదా 3650 రోజులు గతంలో ఉండవచ్చు.

  • పేరు
    email
    టైప్ చేయండి
    string
    వివరణ

    వ్యక్తి ఇమెయిల్ చిరునామా. ఇమెయిల్, ఫోన్ నంబర్ లేదా రెండూ ఇవ్వండి.

  • పేరు
    phone
    టైప్ చేయండి
    string
    వివరణ

    దేశ కోడ్‌తో వ్యక్తి ఫోన్ నంబర్, ఉదా. +919812345678.

  • పేరు
    value
    టైప్ చేయండి
    number
    వివరణ

    ఈవెంట్ విలువ 0 నుంచి, పూర్ణాంక భాగంలో గరిష్ఠంగా 14 అంకెలు మరియు నాలుగు దశాంశ స్థానాలతో ఉండాలి, ఉదా. 1299.50. దాని currency కూడా ఇవ్వండి. customer.created ఈవెంట్‌కు విలువ ఉండదు.

  • పేరు
    currency
    టైప్ చేయండి
    string
    వివరణ

    విలువ కరెన్సీని ISO 4217 కోడ్‌లో ఇవ్వండి, ఉదా. INR.

  • పేరు
    properties
    టైప్ చేయండి
    object
    వివరణ

    క్రింది పట్టిక అనుమతించే ఆ రకం వివరాలు. ఇతర ప్రాపర్టీ తిరస్కరించబడుతుంది.

ఈవెంట్ రకంజరిగిన చర్యఅనుమతించిన ప్రాపర్టీలు
order.placedఆర్డర్ ఇవ్వబడిందిorderNumber, itemCount, productIds
order.paidఆర్డర్‌కు చెల్లించబడిందిorderNumber, itemCount, productIds
order.fulfilledఆర్డర్ నెరవేర్చబడిందిorderNumber, itemCount, productIds
order.cancelledఆర్డర్ రద్దయిందిorderNumber, itemCount, productIds
order.refundedఆర్డర్ సొమ్ము తిరిగిచ్చారుorderNumber, itemCount, productIds
checkout.startedచెక్‌అవుట్ ప్రారంభమైందిitemCount, productIds
cart.abandonedవస్తువులున్న కార్ట్ వదిలేశారుitemCount, productIds
product.viewedఉత్పత్తిని చూశారుproductId
customer.createdవ్యక్తి కస్టమర్ అయ్యారుఏవీ లేవు
  • orderNumber, productId, **productIds**లో ప్రతి గుర్తింపు 1 నుంచి 64 ASCII అక్షరాలుగా ఉంటుంది. మొదట అక్షరం, అంకె లేదా # ఉండాలి; తరువాత . _ : / - కూడా వాడవచ్చు, ఉదా. #1001 లేదా gid://shopify/Product/2.
  • itemCount 0 నుంచి 10000 మధ్య పూర్ణాంకం; **productIds**లో 1 నుంచి 50 గుర్తింపులు ఉంటాయి.
  • ప్రాపర్టీల గరిష్ఠ పరిమాణం 4 KB; పై గుర్తింపులు, లెక్కలనే అంగీకరిస్తాయి. చెల్లింపు కార్డ్ వివరాలు, చిరునామాలు లేదా స్వేచ్ఛా వచనం చేర్చవద్దు; వ్యక్తిని email, phone ద్వారా గుర్తించండి.

చెల్లించిన ఆర్డర్ మరియు వదిలిన కార్ట్

curl -X POST https://api.oblic.app/external/v1/events \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "events": [
      {
        "id": "order-1001-paid",
        "type": "order.paid",
        "occurredAt": "2026-10-20T10:00:00Z",
        "email": "asha@example.org",
        "value": 1299.50,
        "currency": "INR",
        "properties": { "orderNumber": "#1001", "itemCount": 2, "productIds": ["SKU-1", "SKU-2"] }
      },
      {
        "id": "cart-7781",
        "type": "cart.abandoned",
        "occurredAt": "2026-10-20T11:30:00Z",
        "phone": "+919812345678",
        "properties": { "itemCount": 1, "productIds": ["SKU-3"] }
      }
    ]
  }'

ప్రతిస్పందన

{
  "status": "success",
  "data": { "received": 2, "stored": 2, "duplicates": 0, "unmatched": 1 },
  "errors": null
}

ప్రతిస్పందన స్థితి 202:

  • stored కొత్తగా భద్రపరిచిన ఈవెంట్‌ల సంఖ్య; duplicates వాటి id ద్వారా ముందే భద్రపడి, మళ్లీ భద్రపరచని ఈవెంట్‌ల సంఖ్య.
  • unmatched ఇంకా కాంటాక్ట్‌తో సరిపోలని భద్రపరిచిన ఈవెంట్‌ల సంఖ్య. డిఫాల్ట్ వర్క్‌స్పేస్‌లో ఆ ఇమెయిల్ ఉన్న అత్యంత పాత కాంటాక్ట్‌ను ఎంచుకుంటారు; లేకపోతే ఫోన్ లేదా WhatsApp నంబర్‌తో సరిపోలుస్తారు. సరిపోలని ఈవెంట్ వేచి ఉంటుంది. సరిపోల్చే సేవ ప్రారంభమై ఉంటే సాధారణంగా ప్రతి పది నిమిషాలకు నడుస్తుంది; పెండింగ్ పని లేదా వైఫల్యం ఆలస్యం చేయవచ్చు. స్వీకరించిన 30 రోజుల తరువాత కూడా సరిపోలని ఈవెంట్‌లను ఆ సేవ తొలగిస్తుంది. ఈవెంట్ ఎప్పుడూ కాంటాక్ట్‌ను సృష్టించదు.
  • ఉపఖాతా ఈవెంట్‌లు దాని సందేశాల్లాగే దాని X-Oblic-On-Behalf-Ofతో పంపుతారు (ఉపఖాతాలు చూడండి).
తిరస్కరణcdకారణం
400UNKNOWN_EVENT_TYPEఈవెంట్ type అనుమతించిన రకాల్లో లేదు
400PERSON_REQUIREDఈవెంట్‌లో email, phone రెండూ లేవు
400INVALID_VALUEvalueకు currency లేకపోవడం, లేదా విలువ లేకుండా currency, రుణ విలువ, పూర్ణాంక భాగంలో 14 కంటే ఎక్కువ అంకెలు లేదా నాలుగు కంటే ఎక్కువ దశాంశ స్థానాలు, లేదా customer.createdలో విలువ
400INVALID_PROPERTIESఈ రకానికి అనుమతించని ప్రాపర్టీ లేదా తప్పు ఆకృతి
400INVALID_OCCURRED_AToccurredAt ప్రస్తుత సమయం నుంచి ఐదు నిమిషాలకు మించి భవిష్యత్తులో లేదా 3650 రోజులకు మించి గతంలో ఉంది
400సంబంధిత ఫీల్డ్, ఉదా. EVENTS[0].IDevents లేదు, ఖాళీగా ఉంది లేదా 100 కంటే ఎక్కువ అంశాలున్నాయి; లేదా ఫీల్డ్ లేదు లేదా తప్పు ఆకృతిలో ఉంది
403INSUFFICIENT_SCOPEకీకి events:write లేదు

తిరస్కరణలు ఇమెయిల్, ఫోన్ లేదా ప్రాపర్టీ విలువలను తిరిగి చూపకుండా ఫీల్డ్ లేదా అరే స్థానాన్ని సూచిస్తాయి, ఉదా. events[2].type. తెలియని ప్రాపర్టీ పేర్లు వివరణలో కనిపించవచ్చు; పేర్లలోనూ సున్నిత సమాచారం పెట్టవద్దు. ఆకృతి తనిఖీ రకానికి సంబంధించిన తనిఖీలకు ముందు జరుగుతుంది; ఆ దశలో దొరికిన సమస్యలను ప్రతిస్పందన జాబితా చేస్తుంది.


జర్నీ ప్రారంభించడం

వర్క్‌స్పేస్‌కు జర్నీ రన్‌టైమ్ ప్రారంభమై ఉంటే Journeysలో సృష్టించిన జర్నీ కాంటాక్ట్ చర్యతో ప్రారంభం కావచ్చు. ఎడిటర్‌లో మీ స్టోర్‌లో ఏదైనా చేస్తుంది తరువాత ఈవెంట్ రకాన్ని ఎంచుకోండి. పరిమితం చేయడానికి స్టోర్ పంపే ఉత్పత్తి గుర్తింపులు, కరెన్సీతో కనీస విలువ చేర్చండి.

  • ప్రతి ఈవెంట్‌కు ఒక్కసారి: రెండు ఆర్డర్‌లకు చెల్లించిన కాంటాక్ట్ జర్నీని రెండుసార్లు ప్రారంభిస్తారు; అదే idతో మళ్లీ పంపిన ఈవెంట్ ఒక్కసారే ప్రారంభిస్తుంది.
  • ఇటీవలి ఈవెంట్ మాత్రమే: ఈవెంట్ కాంటాక్ట్‌తో భద్రపడినప్పుడు లేదా తరువాత సరిపోలినప్పుడు అది occurredAt నుంచి 24 గంటల్లో ఉంటే జర్నీ మొదలవుతుంది. చారిత్రక ఆర్డర్లను చేర్చే పాత ఈవెంట్‌లు టైమ్‌లైన్, సెగ్మెంట్‌లలో లెక్కలోకి వస్తాయి, కానీ జర్నీ ప్రారంభించవు.
  • ఉత్పత్తులు, విలువ: ఉత్పత్తులు ఆర్డర్, చెక్‌అవుట్ లేదా కార్ట్ productIds లేదా చూసిన productIdతో సరిపోలాలి; విలువ ఆ కరెన్సీలో కనీస మొత్తానికి చేరాలి. customer.createdలో రెండూ లేనందున ఈ షరతులు దానిని పరిమితం చేయవు.

Shopify నుండి

Shopify ఇంటిగ్రేషన్, ఇన్‌స్టాలేషన్ లింక్ కాన్ఫిగర్ చేసినప్పుడు సెట్టింగ్‌లు → ఇంటిగ్రేషన్లు → Shopify స్టోర్ నుంచి స్టోర్‌ను కలపండి: Shopifyలో Oblic యాప్ ఇన్‌స్టాల్ చేసి స్టోర్‌ను సంస్థతో కలపండి. ఇంటిగ్రేషన్ అందుబాటులో లేకపోతే ముందుగా నిర్వాహకుడిని కాన్ఫిగర్ చేయమని అడగండి. ఆర్డర్లు పై ఈవెంట్‌లుగా మారి నేరుగా పంపే ఈవెంట్‌లలాగే ఇమెయిల్ లేదా ఫోన్‌తో సరిపోతాయి. ఇమెయిల్ లేదా SMS మార్కెటింగ్‌కు సభ్యులైన కస్టమర్‌లు ఆ సమ్మతితో కాంటాక్ట్‌లవుతారు.

Shopifyలో మూలంఏర్పడే ఈవెంట్
ఇచ్చిన, చెల్లించిన, నెరవేర్చిన లేదా రద్దయిన ఆర్డర్order.placed, order.paid, order.fulfilled, order.cancelled
రీఫండ్order.refunded, ఆర్డర్ ఇచ్చిన వ్యక్తికి తిరిగిచ్చిన మొత్తంతో
ఇమెయిల్ లేదా ఫోన్ ఉన్న చెక్‌అవుట్checkout.started
ఆర్డర్ లేకుండా గంటపాటు నిష్క్రియమైన చెక్‌అవుట్cart.abandoned, ప్రతి చెక్‌అవుట్‌కు ఒక్కసారి
మార్కెటింగ్ సభ్యుడైన, ఇంకా కాంటాక్ట్ కాని కస్టమర్customer.created, Oblic కాంటాక్ట్‌ను సృష్టించినప్పుడు
  • ఈవెంట్ విషయాలు: స్టోర్ కరెన్సీలో ఆర్డర్ విలువ, సంఖ్య, వస్తువుల లెక్క, Shopify గుర్తింపులతో ఉత్పత్తులు. ఆర్డర్ ఇతర వివరాలను ఈవెంట్‌లో భద్రపరచరు.
  • సభ్యులైన కస్టమర్‌లు: Shopifyలో ఇమెయిల్ లేదా SMS మార్కెటింగ్ సభ్యుడైన కస్టమర్‌ను ఈవెంట్ సరిపోలిక నియమాలతో కాంటాక్ట్‌లలో వెతుకుతారు. లేకపోతే డిఫాల్ట్ వర్క్‌స్పేస్‌లో చిరునామా లేదా నంబర్‌ను పేరుగా పెట్టి కాంటాక్ట్‌ను సృష్టించి దానిపై సమ్మతి నమోదు చేస్తారు. సభ్యుడు కాని కస్టమర్‌ను కాంటాక్ట్‌గా సృష్టించరు.
  • సభ్యత్వం రద్దు: Shopifyలో రద్దు చేసుకున్న కస్టమర్‌కు అక్కడ మళ్లీ చేరేవరకు ఇమెయిల్ లేదా ప్రచారాలు, ఆటోమేషన్లు, జర్నీల SMS పంపరు. సందేశ లింక్ వంటి మార్గంలో Oblicలో చేసిన ఇమెయిల్ చందా రద్దును Shopify ఎన్నడూ మార్చదు.
  • కనెక్షన్ తొలగించడం: అదే పేజీలో స్టోర్‌ను వేరుచేసి Shopifyలో Oblic యాప్ అన్‌ఇన్‌స్టాల్ చేయండి. వేరుచేసినప్పుడు ఈవెంట్‌లు ఉంటాయి. Shopify తరువాతి shop/redact అభ్యర్థన ప్రాసెస్ అయినప్పుడు స్టోర్, ఈవెంట్‌లు తొలగుతాయి; కేవలం వేరుచేయడం వల్ల కాదు.
  • కస్టమర్ గోప్యత: Shopify కస్టమర్ డేటాను తొలగించమంటే ఆ స్టోర్ నుంచి వచ్చిన వారి ఈవెంట్‌లు తొలగుతాయి. కాంటాక్ట్‌పై సమ్మతి నమోదై ఉంటే దానిని తొలగించమని సంస్థ యజమానులకు Oblicలో తెలియజేస్తారు. కస్టమర్ తన డేటాను అడిగినప్పుడూ యజమానులకు Oblicలో సమాచారం అందుతుంది.
ఈ పేజీ సహాయకరంగా ఉందా?