{
"error": "Internal validation failed",
"details": "Cannot redeem 50 points. Only 30 left under the 24-hour redemption limit."
}
Behavior
Emit event
Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer’s tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.
Optional campaign and matching context captured by the caller and forwarded with the event. Include the same context on the purchase. Cookies must be captured from the client; they are not generated from UTM values.
Google tag/Firebase identity and session captured when the event occurred. Optional: missing identity keeps the legacy customer-ID fallback on the web stream, without reliable session attribution. Never include API secrets.
Optional ISO 8601 timestamp of when the event occurred. It must include timezone information: use UTC with Z (recommended) or an explicit offset such as -05:00. Do not append Z to an unconverted local time. Must be within the last 72 hours and cannot be in the future. Defaults to the current server time if not provided.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Masivo","colors":{"primary":"#9333ea","light":"#c084fc","dark":"#9333ea"},"logo":{"light":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/light.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d6c63ec91328f53e2881c4b8c6463002","dark":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/dark.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=4f3a37e246a4bdd211beae4f51571bea","href":"/"},"favicon":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/favicon.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d626565ed6bd780993b9f7d91f7ab1be","navbar":{"links":[{"href":"mailto:soporte@trade.ec?subject=Masivo Support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.masivo.ai"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://www.linkedin.com/company/mintsearch"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Roadmap","icon":"map","href":"https://docs.masivo.ai/roadmap"},{"anchor":"Changelog","icon":"rocket","href":"https://docs.masivo.ai/changelog"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/2DgqGUej"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trd","hasAudioNarration":false,"actualSubdomain":"trd","customDomains":["docs.masivo.ai"],"gitSource":{"type":"github","owner":"trade-ec","repo":"masivo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae342ccbefa89197b169622","collectionId":"f24d0b41-a58e-4ab3-99cd-6de00b6e057b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae342ccbefa89197b169622"},"entitlements":{},"buildId":"6ae342ccbefa89197b169622","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":93},{"language":"default","tag":"Documentation","count":88},{"language":"default","tag":"Endpoints","count":73},{"language":"default","tag":"Guides","count":72},{"language":"default","tag":"Get Started","count":23},{"language":"default","tag":"Concepts","count":20},{"language":"default","tag":"Marketing Automation","count":19},{"language":"default","tag":"Customers","count":17},{"language":"default","tag":"CDP","count":17},{"language":"default","tag":"Integrations","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/behavior/events/post","slug":"/api-reference/behavior/events/post","pageMetadata":{"title":"Emit event","openapi":"POST /behavior/events","description":"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer's tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.","href":"/api-reference/behavior/events/post"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer’s tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Emit event","openapi":"POST /behavior/events","description":"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer's tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.","href":"/api-reference/behavior/events/post"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer's tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.","requestBody":"77185c97-ee8b-4840-83e2-e0b20edfb03f","responses":{"200":"a1b8e1bb-0a42-4789-98bd-d80a80131b45","422":"6a056255-8ffa-47dd-8555-e7e84f3c1717"},"method":"post","type":"path","servers":["bfa79d19-faf8-4b65-9f12-2bd5b6069d7f"],"security":["e5fbaeb9-73b3-4320-8dec-e2c171b31efa"],"path":"/behavior/events","baseUrlOptions":["https://app.masivo.ai/api/storefront/v1"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["customer_id","brand_id","type"],"properties":{"customer_id":{"type":"string","description":"The customer unique identifier in your system","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"brand_id":{"type":"string","description":"The id of the brand that originate the event","isRequired":true,"uniqueKey":"brand_id","typeLabel":"string"},"type":{"type":"string","description":"The type of the event","example":"PURCHASE","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"platform":{"oneOf":[{"type":"string","description":"Platform name where the event originated","uniqueKey":"platform.oneOf.0","typeLabel":"string"},{"type":"null","description":"Platform name where the event originated","uniqueKey":"platform.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform","typeLabel":"string | null"},"order":{"type":"object","required":["purchase_id","value","products","payment_method"],"properties":{"purchase_id":{"type":"string","description":"The id of a placed order in your system","isRequired":true,"uniqueKey":"order.purchase_id","typeLabel":"string"},"value":{"type":"number","description":"The order total or subtotal","example":20.95,"isRequired":true,"uniqueKey":"order.value","typeLabel":"number"},"products":{"type":"array","description":"Products in the order. Product sku values are used to match campaign and reward e-commerce product restrictions.","minimum":1,"items":{"type":"object","required":["sku","amount","value"],"properties":{"sku":{"type":"string","description":"The product sku. Used to match campaign and reward e-commerce product restrictions.","isRequired":true,"uniqueKey":"order.products.items.[INDEX].sku","typeLabel":"string"},"amount":{"type":"number","description":"The quantity of the product","isRequired":true,"uniqueKey":"order.products.items.[INDEX].amount","typeLabel":"number"},"value":{"type":"number","description":"The total or subtotal of the product","isRequired":true,"uniqueKey":"order.products.items.[INDEX].value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The total or subtotal of the product after discounts","uniqueKey":"order.products.items.[INDEX].discounted_value","typeLabel":"number"},"redeem":{"type":"array","description":"The rewards to redeem in the product","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.products.items.[INDEX].redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"order.products.items.[INDEX].tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"order.products.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"order.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"order.products","typeLabel":"object[]"},"payment_method":{"type":"string","description":"The payment method used in the order","enum":["CREDIT","DEBIT","CASH","BANK_TRANSFER","OTHER"],"isRequired":true,"uniqueKey":"order.payment_method","typeLabel":"enum\u003cstring>"},"channel_id":{"type":"string","description":"The channel unique identifier in your system. Used to match campaign and reward e-commerce channel restrictions.","uniqueKey":"order.channel_id","typeLabel":"string"},"store_id":{"type":"string","description":"The store unique identifier in your system. Used to match campaign and reward e-commerce store restrictions.","uniqueKey":"order.store_id","typeLabel":"string"},"discounted_value":{"type":"number","description":"The order total or subtotal after discounts","example":10.95,"uniqueKey":"order.discounted_value","typeLabel":"number"},"shipping":{"type":"object","properties":{"value":{"type":"number","description":"The shipping cost","example":3.25,"uniqueKey":"order.shipping.value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The shipping cost after discounts","example":2.25,"uniqueKey":"order.shipping.discounted_value","typeLabel":"number"},"redeem":{"type":"array","description":"The rewards to redeem in the shipping","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.shipping.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.shipping.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.shipping.redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping.redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"order.shipping.tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"order.shipping.metadata","typeLabel":"object"}},"description":"The shipping information of the order","uniqueKey":"order.shipping","typeLabel":"object"},"redeem":{"type":"array","description":"The rewards to redeem in the order","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.redeem","typeLabel":"object[]"},"metadata":{"type":"object","description":"The metadata of the order","uniqueKey":"order.metadata","typeLabel":"object"}},"description":"The order in case of a PURCHASE event","uniqueKey":"order","typeLabel":"object"},"product":{"type":"object","required":["sku","amount","value"],"properties":{"sku":{"type":"string","description":"The product sku. Used to match campaign and reward e-commerce product restrictions.","isRequired":true,"uniqueKey":"product.sku","typeLabel":"string"},"amount":{"type":"number","description":"The quantity of the product","isRequired":true,"uniqueKey":"product.amount","typeLabel":"number"},"value":{"type":"number","description":"The total or subtotal of the product","isRequired":true,"uniqueKey":"product.value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The total or subtotal of the product after discounts","uniqueKey":"product.discounted_value","typeLabel":"number"},"redeem":{"type":"array","description":"The rewards to redeem in the product","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"product.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"product.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"product.redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"product.tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"product.metadata","typeLabel":"object"}},"description":"The product in case of an ADD_TO_CART event","uniqueKey":"product","typeLabel":"object"},"fulfilled":{"type":"boolean","description":"If the event was fulfilled, when false, rewards to be redeemed will be reserved until fulfilled","default":true,"uniqueKey":"fulfilled","typeLabel":"boolean"},"reserve":{"type":"number","format":"int2","description":"The number of days to reserve the rewards","default":1,"uniqueKey":"reserve","typeLabel":"number\u003cint2>"},"redeem":{"type":"array","description":"The rewards to redeem in the order","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"tags","typeLabel":"object"},"referral_code":{"type":"string","description":"(Optional) The referral code to track the event","uniqueKey":"referral_code","typeLabel":"string"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"metadata","typeLabel":"object"},"attribution":{"type":"object","description":"Optional campaign and matching context captured by the caller and forwarded with the event. Include the same context on the purchase. Cookies must be captured from the client; they are not generated from UTM values.","properties":{"tracking_id":{"type":"string","description":"Masivo tracking identifier from the link.","uniqueKey":"attribution.tracking_id","typeLabel":"string"},"utm_source":{"type":"string","uniqueKey":"attribution.utm_source","typeLabel":"string"},"utm_medium":{"type":"string","uniqueKey":"attribution.utm_medium","typeLabel":"string"},"utm_campaign":{"type":"string","uniqueKey":"attribution.utm_campaign","typeLabel":"string"},"utm_term":{"type":"string","uniqueKey":"attribution.utm_term","typeLabel":"string"},"utm_content":{"type":"string","uniqueKey":"attribution.utm_content","typeLabel":"string"},"utm_referral":{"type":"string","uniqueKey":"attribution.utm_referral","typeLabel":"string"},"gclid":{"type":"string","uniqueKey":"attribution.gclid","typeLabel":"string"},"gbraid":{"type":"string","uniqueKey":"attribution.gbraid","typeLabel":"string"},"wbraid":{"type":"string","uniqueKey":"attribution.wbraid","typeLabel":"string"},"fbclid":{"type":"string","uniqueKey":"attribution.fbclid","typeLabel":"string"},"ttclid":{"type":"string","uniqueKey":"attribution.ttclid","typeLabel":"string"},"fbc":{"type":"string","uniqueKey":"attribution.fbc","typeLabel":"string"},"fbp":{"type":"string","uniqueKey":"attribution.fbp","typeLabel":"string"},"ttp":{"type":"string","uniqueKey":"attribution.ttp","typeLabel":"string"},"event_source_url":{"type":"string","format":"uri","uniqueKey":"attribution.event_source_url","typeLabel":"string\u003curi>"}},"uniqueKey":"attribution","typeLabel":"object"},"ga4":{"type":"object","required":["platform"],"description":"Google tag/Firebase identity and session captured when the event occurred. Optional: missing identity keeps the legacy customer-ID fallback on the web stream, without reliable session attribution. Never include API secrets.","properties":{"platform":{"type":"string","enum":["web","android","ios"],"isRequired":true,"uniqueKey":"ga4.platform","typeLabel":"enum\u003cstring>"},"client_id":{"type":"string","minLength":1,"maxLength":256,"description":"Google tag client ID. Web only; cannot be combined with app_instance_id.","uniqueKey":"ga4.client_id","typeLabel":"string"},"app_instance_id":{"type":"string","pattern":"^[a-fA-F0-9]{32}$","description":"Firebase installation ID. Android/iOS only; cannot be combined with client_id.","uniqueKey":"ga4.app_instance_id","typeLabel":"string"},"session_id":{"oneOf":[{"type":"integer","description":"The original session ID. Must be a positive integer or numeric string on all platforms.","minimum":1,"uniqueKey":"ga4.session_id.oneOf.0","typeLabel":"integer"},{"type":"string","description":"The original session ID. Must be a positive integer or numeric string on all platforms.","maxLength":256,"pattern":"^[1-9]\\d*$","uniqueKey":"ga4.session_id.oneOf.1","typeLabel":"string"}],"uniqueKey":"ga4.session_id","typeLabel":"integer | string"},"user_id":{"type":"string","minLength":1,"maxLength":256,"description":"Optional non-PII User-ID explicitly configured in the tag/Firebase SDK.","uniqueKey":"ga4.user_id","typeLabel":"string"},"engagement_time_msec":{"type":"integer","minimum":0,"description":"Measured engagement duration since the preceding event, in milliseconds.","uniqueKey":"ga4.engagement_time_msec","typeLabel":"integer"}},"uniqueKey":"ga4","typeLabel":"object"},"issued_at":{"type":"string","format":"date-time","description":"Optional ISO 8601 timestamp of when the event occurred. It must include timezone information: use UTC with Z (recommended) or an explicit offset such as -05:00. Do not append Z to an unconverted local time. Must be within the last 72 hours and cannot be in the future. Defaults to the current server time if not provided.","example":"2026-03-25T10:00:00.000Z","uniqueKey":"issued_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"a1b8e1bb-0a42-4789-98bd-d80a80131b45":{"description":"Event enqueued for processing","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The event internal unique identifier","format":"uuid","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"customer_id":{"type":"string","description":"The customer id of the event","format":"uuid","uniqueKey":"data.customer_id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"The type of the event","example":"PURCHASE","uniqueKey":"data.type","typeLabel":"string"},"data":{"type":"object","description":"The data used in the event","uniqueKey":"data.data","typeLabel":"object"},"fulfilled":{"type":"boolean","description":"If the event was fulfilled.","uniqueKey":"data.fulfilled","typeLabel":"boolean"},"reserve":{"type":"number","format":"int2","description":"The number of days to reserve the rewards","uniqueKey":"data.reserve","typeLabel":"number\u003cint2>"},"queue_message_id":{"type":"string","description":"The message id in the queue","uniqueKey":"data.queue_message_id","typeLabel":"string"},"rewarding_campaigns":{"type":"array","description":"The campaigns that rewarded the event including the rules that matched","uniqueKey":"data.rewarding_campaigns","typeLabel":"array"},"status":{"type":"string","description":"The status of the event","enum":["PENDING","PROCESSING","FAILED","RESOLVED","CANCELLED","EXPIRED","REVERSED"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"result":{"type":"object","properties":{"wallet":{"type":"object","description":"The wallet state after the event","items":{"type":"object","properties":{"id":{"type":"string","description":"The wallet internal unique identifier","format":"uuid"},"owner_id":{"type":"string","description":"The customer internal unique identifier","format":"uuid"},"lines":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the line"},"reward_id":{"type":"string","description":"The reward id of the line","format":"uuid"},"campaign_id":{"oneOf":[{"type":"string","description":"The campaign id of the line","format":"uuid"},{"type":"null","description":"The campaign id of the line","format":"uuid"}]},"brand_id":{"oneOf":[{"type":"string","description":"The id of the brand that originated the line","format":"uuid"},{"type":"null","description":"The id of the brand that originated the line","format":"uuid"}]},"issued_at":{"type":"string","description":"The date when the line was issued","format":"date-time"},"expiration_date":{"type":"string","description":"The expiration date of the line","format":"date-time"},"reservation_expires_at":{"oneOf":[{"type":"string","description":"The reservation expiration date of the line","format":"date-time"},{"type":"null","description":"The reservation expiration date of the line","format":"date-time"}]}}},"description":"Each line represents a batch of a given reward_id that expires at the same time"},"totals":{"type":"array","description":"The wallet totals by reward","items":{"type":"object","properties":{"total":{"type":"number","description":"The total amount of the reward","example":127.6},"reward_id":{"type":"string","description":"The reward id of the total","format":"uuid"},"expiration_date":{"type":"string","description":"The expiration date of the total","format":"date-time"},"reward":{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward"},{"type":"null","description":"The brand id of the reward, null if is a global reward"}]},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"]},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string"}},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid"}]},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string"}},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string"}},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"}},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"}}]},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"}},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"}}]},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"}},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"}}]},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"}},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"}}]},"name":{"type":"string","description":"The name of the reward"},"description":{"type":"string","description":"The description of the reward"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"]},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"]},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95},{"type":"string","description":"The value to compare"},{"type":"boolean","description":"The value to compare"}]}}}}},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1}}},{"type":"object","description":"The attributes of the reward","additionalProperties":true},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"]},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"]}}}]}}}}}}}},"uniqueKey":"data.result.wallet","typeLabel":"object"},"customer":{"type":"object","description":"The customer state after the event","items":{"type":"object","required":["id","name","email","registration_date"],"properties":{"id":{"type":"string","description":"Your customer unique identifier"},"status":{"description":"The status of the customer","type":"string","enum":["ACTIVE","INACTIVE"]},"is_anonymous":{"description":"Whether the customer is anonymous","type":"boolean","default":false},"name":{"description":"The full name of the customer","type":"string","example":"John Smith"},"email":{"description":"The email of the customer","type":"string","format":"email"},"gender":{"oneOf":[{"description":"The gender of the customer","type":"string","enum":["MALE","FEMALE"]},{"description":"The gender of the customer","type":"null","enum":["MALE","FEMALE"]}]},"dob":{"oneOf":[{"description":"The date of birth of the customer","type":"string","format":"date-time"},{"description":"The date of birth of the customer","type":"null","format":"date-time"}]},"document_type":{"oneOf":[{"type":"string","description":"The document type of the customer","enum":["AR_DNI","AR_CUIT","AR_CUIL","AR_PASSPORT","AR_DRIVER_LICENSE","AR_OTHER","BO_CI","BO_NIT","BO_PASSPORT","BO_DRIVER_LICENSE","BO_OTHER","BR_RG","BR_CPF","BR_PASSPORT","BR_DRIVER_LICENSE","BR_OTHER","CL_RUN","CL_RUT","CL_PASSPORT","CL_DRIVER_LICENSE","CL_OTHER","CO_CC","CO_RUT","CO_NIT","CO_PASSPORT","CO_DRIVER_LICENSE","CO_OTHER","CR_CI","CR_PASSPORT","CR_DRIVER_LICENSE","CR_OTHER","DO_CI","DO_PASSPORT","DO_DRIVER_LICENSE","DO_OTHER","EC_CC","EC_RUC","EC_PASSPORT","EC_DRIVER_LICENSE","EC_OTHER","SV_DUI","SV_NIT","SV_PASSPORT","SV_DRIVER_LICENSE","SV_OTHER","GT_DPI","GT_PASSPORT","GT_DRIVER_LICENSE","GT_OTHER","HN_CI","HN_RTN","HN_PASSPORT","HN_DRIVER_LICENSE","HN_OTHER","MX_CURP","MX_RFC","MX_INE","MX_PASSPORT","MX_DRIVER_LICENSE","MX_OTHER","NI_CI","NI_PASSPORT","NI_DRIVER_LICENSE","NI_OTHER","PA_CIP","PA_PASSPORT","PA_DRIVER_LICENSE","PA_OTHER","PY_CI","PY_RUC","PY_PASSPORT","PY_DRIVER_LICENSE","PY_OTHER","PE_DNI","PE_RUC","PE_PASSPORT","PE_DRIVER_LICENSE","PE_OTHER","UY_CI","UY_RUT","UY_PASSPORT","UY_DRIVER_LICENSE","UY_OTHER","VE_CI","VE_RIF","VE_PASSPORT","VE_DRIVER_LICENSE","VE_OTHER"],"example":"CL_RUT"},{"type":"null"}]},"document_number":{"oneOf":[{"description":"The document number of the customer","type":"string","maxLength":50},{"description":"The document number of the customer","type":"null","maxLength":50}]},"country":{"oneOf":[{"type":"string","description":"The country of the customer. English name, independent of the document_type prefix.","enum":["Argentina","Bolivia","Brazil","Chile","Colombia","Costa Rica","Dominican Republic","Ecuador","El Salvador","Guatemala","Honduras","Mexico","Nicaragua","Panama","Paraguay","Peru","Uruguay","Venezuela"],"example":"Chile"},{"type":"null"}]},"phone":{"oneOf":[{"description":"The customer's phone number in international format. Required for WhatsApp delivery.","type":"string","example":"+593 99 123 4567"},{"description":"The customer's phone number in international format. Required for WhatsApp delivery.","type":"null","example":"+593 99 123 4567"}]},"phone_verified":{"description":"Whether the customer's phone number is verified","type":"boolean","default":false},"registration_date":{"description":"The date when the customer was registered","type":"string","format":"date-time"},"tier_id":{"description":"The id of the tier the customer currently belongs to","type":"string","format":"uuid"},"tags":{"type":"object","description":"Include your conditions customer tags here"},"consent":{"oneOf":[{"type":"object","required":["consent_string"],"properties":{"version":{"type":"string","description":"IAB TCF version","example":"2.0"},"consent_timestamp":{"type":"string","format":"date-time","description":"The timestamp when consent was given"},"customer_id":{"type":"string","description":"The customer unique identifier"},"purposes":{"type":"object","properties":{"behavioral_campaigns":{"type":"boolean","description":"Consent for behavioral campaigns"},"coupon_campaigns":{"type":"boolean","description":"Consent for coupon campaigns"},"punchcard_campaigns":{"type":"boolean","description":"Consent for punchcard campaigns"},"email_marketing":{"type":"boolean","description":"Consent for email marketing"},"push_notifications":{"type":"boolean","description":"Consent for push notifications"},"whatsapp_marketing":{"type":"boolean","description":"Consent for WhatsApp marketing messages"},"audience_marketing":{"type":"boolean","description":"Consent to belong to marketing audiences"},"inapp_messages":{"type":"boolean","description":"Consent for in-app messages"},"news_feed":{"type":"boolean","description":"Consent for news feed cards"},"link_tracking":{"type":"boolean","description":"Consent for link click tracking. When `false`, clicks on links that carry this customer's `customer_id` are not stored (the link still opens), and `/events/identify` does not link a `tracking_id` to this customer."}}},"vendors":{"type":"object","description":"Vendor consent mapping (vendor_id: boolean)","additionalProperties":{"type":"boolean"},"example":{"vendor_123":true,"vendor_456":false}},"consent_string":{"type":"string","description":"IAB TCF consent string in base64url format, starting with 'CO', minimum 20 characters, maximum 500 characters","example":"COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA","minLength":20,"maxLength":500,"pattern":"^CO[A-Za-z0-9_-]+$"}},"description":"The customer's consent preferences"},{"type":"null","required":["consent_string"],"properties":{"version":{"type":"string","description":"IAB TCF version","example":"2.0"},"consent_timestamp":{"type":"string","format":"date-time","description":"The timestamp when consent was given"},"customer_id":{"type":"string","description":"The customer unique identifier"},"purposes":{"type":"object","properties":{"behavioral_campaigns":{"type":"boolean","description":"Consent for behavioral campaigns"},"coupon_campaigns":{"type":"boolean","description":"Consent for coupon campaigns"},"punchcard_campaigns":{"type":"boolean","description":"Consent for punchcard campaigns"},"email_marketing":{"type":"boolean","description":"Consent for email marketing"},"push_notifications":{"type":"boolean","description":"Consent for push notifications"},"whatsapp_marketing":{"type":"boolean","description":"Consent for WhatsApp marketing messages"},"audience_marketing":{"type":"boolean","description":"Consent to belong to marketing audiences"},"inapp_messages":{"type":"boolean","description":"Consent for in-app messages"},"news_feed":{"type":"boolean","description":"Consent for news feed cards"},"link_tracking":{"type":"boolean","description":"Consent for link click tracking. When `false`, clicks on links that carry this customer's `customer_id` are not stored (the link still opens), and `/events/identify` does not link a `tracking_id` to this customer."}}},"vendors":{"type":"object","description":"Vendor consent mapping (vendor_id: boolean)","additionalProperties":{"type":"boolean"},"example":{"vendor_123":true,"vendor_456":false}},"consent_string":{"type":"string","description":"IAB TCF consent string in base64url format, starting with 'CO', minimum 20 characters, maximum 500 characters","example":"COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA","minLength":20,"maxLength":500,"pattern":"^CO[A-Za-z0-9_-]+$"}},"description":"The customer's consent preferences"}]},"metrics":{"description":"The metrics of the customer","type":"object"},"metadata":{"description":"The metadata of the customer","type":"object"}}},"uniqueKey":"data.result.customer","typeLabel":"object"},"gift_card":{"type":"array","description":"Gift cards related to the event","items":{"type":"object","required":["code","reward_id","customer_id","rewarded_at"],"properties":{"code":{"type":"string","description":"The gift card code to use in the store","isRequired":true,"uniqueKey":"data.result.gift_card.items.[INDEX].code","typeLabel":"string"},"reward_id":{"type":"string","description":"The reward id of the gift card","format":"uuid","isRequired":true,"uniqueKey":"data.result.gift_card.items.[INDEX].reward_id","typeLabel":"string\u003cuuid>"},"customer_id":{"type":"string","description":"The customer id that owns the gift card","format":"uuid","isRequired":true,"uniqueKey":"data.result.gift_card.items.[INDEX].customer_id","typeLabel":"string\u003cuuid>"},"rewarded_at":{"type":"string","description":"The date when the gift card was issued to a customer","format":"date-time","isRequired":true,"uniqueKey":"data.result.gift_card.items.[INDEX].rewarded_at","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","description":"The gift card description","uniqueKey":"data.result.gift_card.items.[INDEX].description","typeLabel":"string"},"expired_at":{"oneOf":[{"type":"string","description":"The expiration date of the gift card","format":"date-time","uniqueKey":"data.result.gift_card.items.[INDEX].expired_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The expiration date of the gift card","format":"date-time","uniqueKey":"data.result.gift_card.items.[INDEX].expired_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.gift_card.items.[INDEX].expired_at","typeLabel":"string\u003cdate-time> | null"},"redeemed_at":{"oneOf":[{"type":"string","description":"The date when the gift card was redeemed","format":"date-time","uniqueKey":"data.result.gift_card.items.[INDEX].redeemed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the gift card was redeemed","format":"date-time","uniqueKey":"data.result.gift_card.items.[INDEX].redeemed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.gift_card.items.[INDEX].redeemed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.result.gift_card.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.result.gift_card","typeLabel":"object[]"},"accumulations":{"type":"array","description":"Total accumulations after the event","items":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the line","uniqueKey":"data.result.accumulations.items.[INDEX].amount","typeLabel":"number"},"reward_id":{"type":"string","description":"The reward id of the line","format":"uuid","uniqueKey":"data.result.accumulations.items.[INDEX].reward_id","typeLabel":"string\u003cuuid>"},"campaign_id":{"oneOf":[{"type":"string","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.accumulations.items.[INDEX].campaign_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.accumulations.items.[INDEX].campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.accumulations.items.[INDEX].campaign_id","typeLabel":"string\u003cuuid> | null"},"brand_id":{"oneOf":[{"type":"string","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.accumulations.items.[INDEX].brand_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.accumulations.items.[INDEX].brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.accumulations.items.[INDEX].brand_id","typeLabel":"string\u003cuuid> | null"},"issued_at":{"type":"string","description":"The date when the line was issued","format":"date-time","uniqueKey":"data.result.accumulations.items.[INDEX].issued_at","typeLabel":"string\u003cdate-time>"},"expiration_date":{"type":"string","description":"The expiration date of the line","format":"date-time","uniqueKey":"data.result.accumulations.items.[INDEX].expiration_date","typeLabel":"string\u003cdate-time>"},"reservation_expires_at":{"oneOf":[{"type":"string","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.accumulations.items.[INDEX].reservation_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.accumulations.items.[INDEX].reservation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.accumulations.items.[INDEX].reservation_expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.result.accumulations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.result.accumulations","typeLabel":"object[]"},"redemptions":{"type":"array","description":"Redemptions made during the event","items":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the line","uniqueKey":"data.result.redemptions.items.[INDEX].amount","typeLabel":"number"},"reward_id":{"type":"string","description":"The reward id of the line","format":"uuid","uniqueKey":"data.result.redemptions.items.[INDEX].reward_id","typeLabel":"string\u003cuuid>"},"campaign_id":{"oneOf":[{"type":"string","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.redemptions.items.[INDEX].campaign_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.redemptions.items.[INDEX].campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.redemptions.items.[INDEX].campaign_id","typeLabel":"string\u003cuuid> | null"},"brand_id":{"oneOf":[{"type":"string","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.redemptions.items.[INDEX].brand_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.redemptions.items.[INDEX].brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.redemptions.items.[INDEX].brand_id","typeLabel":"string\u003cuuid> | null"},"issued_at":{"type":"string","description":"The date when the line was issued","format":"date-time","uniqueKey":"data.result.redemptions.items.[INDEX].issued_at","typeLabel":"string\u003cdate-time>"},"expiration_date":{"type":"string","description":"The expiration date of the line","format":"date-time","uniqueKey":"data.result.redemptions.items.[INDEX].expiration_date","typeLabel":"string\u003cdate-time>"},"reservation_expires_at":{"oneOf":[{"type":"string","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.redemptions.items.[INDEX].reservation_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.redemptions.items.[INDEX].reservation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.redemptions.items.[INDEX].reservation_expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.result.redemptions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.result.redemptions","typeLabel":"object[]"},"transactions":{"type":"array","description":"Total transactions after the event","items":{"type":"object","properties":{"id":{"type":"string","description":"The transaction internal unique identifier","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].brand_id","typeLabel":"string | null"},"event_id":{"oneOf":[{"type":"string","description":"The id of the event the created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].event_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the event the created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].event_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].event_id","typeLabel":"string\u003cuuid> | null"},"campaign_id":{"oneOf":[{"type":"string","description":"The id of the campaign that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].campaign_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the campaign that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].campaign_id","typeLabel":"string\u003cuuid> | null"},"channel_id":{"oneOf":[{"type":"string","description":"The id of the channel that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].channel_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the channel that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].channel_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].channel_id","typeLabel":"string\u003cuuid> | null"},"store_id":{"oneOf":[{"type":"string","description":"The id of the store that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].store_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the store that created the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].store_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].store_id","typeLabel":"string\u003cuuid> | null"},"funded_by":{"oneOf":[{"type":"string","description":"Who funded the rewards used in this transaction","example":"MARKETING","uniqueKey":"data.result.transactions.items.[INDEX].funded_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"Who funded the rewards used in this transaction","example":"MARKETING","uniqueKey":"data.result.transactions.items.[INDEX].funded_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].funded_by","typeLabel":"string | null"},"event_type":{"type":"string","description":"The type of the event that created the transaction","example":"PURCHASE","uniqueKey":"data.result.transactions.items.[INDEX].event_type","typeLabel":"string"},"reward_type":{"type":"string","description":"The type of the reward used in the transaction","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"data.result.transactions.items.[INDEX].reward_type","typeLabel":"enum\u003cstring>"},"reward_id":{"type":"string","description":"The reward id of the transaction","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].reward_id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].amount","typeLabel":"number"},"cost":{"oneOf":[{"type":"number","description":"The cost of the rewards used in the transaction","uniqueKey":"data.result.transactions.items.[INDEX].cost.oneOf.0","typeLabel":"number"},{"type":"null","description":"The cost of the rewards used in the transaction","uniqueKey":"data.result.transactions.items.[INDEX].cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].cost","typeLabel":"number | null"},"details":{"type":"string","description":"The explanation of why transaction was created","uniqueKey":"data.result.transactions.items.[INDEX].details","typeLabel":"string"},"type":{"type":"string","description":"The type of the transaction","enum":["ACCUMULATION","REDEMPTION","EXPIRATION","MIGRATION","TRANSFER","REVERSAL"],"uniqueKey":"data.result.transactions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"receiver_id":{"type":"string","description":"The receiver id of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].receiver_id","typeLabel":"string"},"sender_id":{"type":"string","description":"The sender id of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].sender_id","typeLabel":"string"},"created_at":{"type":"string","description":"The date when the transaction was created","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"issued_at":{"type":"string","description":"The date when the transaction was issued","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].issued_at","typeLabel":"string\u003cdate-time>"},"attributes":{"type":"object","description":"The attributes of the transaction","required":["line"],"properties":{"line":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the line","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.amount","typeLabel":"number"},"reward_id":{"type":"string","description":"The reward id of the line","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.reward_id","typeLabel":"string\u003cuuid>"},"campaign_id":{"oneOf":[{"type":"string","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.campaign_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The campaign id of the line","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.campaign_id","typeLabel":"string\u003cuuid> | null"},"brand_id":{"oneOf":[{"type":"string","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.brand_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The id of the brand that originated the line","format":"uuid","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.brand_id","typeLabel":"string\u003cuuid> | null"},"issued_at":{"type":"string","description":"The date when the line was issued","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.issued_at","typeLabel":"string\u003cdate-time>"},"expiration_date":{"type":"string","description":"The expiration date of the line","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.expiration_date","typeLabel":"string\u003cdate-time>"},"reservation_expires_at":{"oneOf":[{"type":"string","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.reservation_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The reservation expiration date of the line","format":"date-time","uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.reservation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0.reservation_expires_at","typeLabel":"string\u003cdate-time> | null"}},"description":"The line used to create the transaction","isRequired":true,"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"number","description":"The amount of the line"},"reward_id":{"type":"string","description":"The reward id of the line","format":"uuid"},"campaign_id":{"oneOf":[{"type":"string","description":"The campaign id of the line","format":"uuid"},{"type":"null","description":"The campaign id of the line","format":"uuid"}]},"brand_id":{"oneOf":[{"type":"string","description":"The id of the brand that originated the line","format":"uuid"},{"type":"null","description":"The id of the brand that originated the line","format":"uuid"}]},"issued_at":{"type":"string","description":"The date when the line was issued","format":"date-time"},"expiration_date":{"type":"string","description":"The expiration date of the line","format":"date-time"},"reservation_expires_at":{"oneOf":[{"type":"string","description":"The reservation expiration date of the line","format":"date-time"},{"type":"null","description":"The reservation expiration date of the line","format":"date-time"}]}},"description":"The line used to create the transaction","isRequired":true,"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.result.transactions.items.[INDEX].attributes.line","typeLabel":"object | null"},"campaign_name":{"type":"string","description":"The name of the campaign that created the transaction","uniqueKey":"data.result.transactions.items.[INDEX].attributes.campaign_name","typeLabel":"string"}},"uniqueKey":"data.result.transactions.items.[INDEX].attributes","typeLabel":"object"},"metadata":{"type":"object","description":"The metadata of the transaction","uniqueKey":"data.result.transactions.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"data.result.transactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.result.transactions","typeLabel":"object[]"},"customer_by_tier":{"type":"array","description":"Customer tier changes resulting from the event","items":{"type":"object","uniqueKey":"data.result.customer_by_tier.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.result.customer_by_tier","typeLabel":"object[]"}},"description":"The result of the event","uniqueKey":"data.result","typeLabel":"object"},"issued_at":{"type":"string","description":"The date when the event was issued","format":"date-time","uniqueKey":"data.issued_at","typeLabel":"string\u003cdate-time>"},"processing_at":{"oneOf":[{"type":"string","description":"The date when the event was processed","format":"date-time","uniqueKey":"data.processing_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the event was processed","format":"date-time","uniqueKey":"data.processing_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.processing_at","typeLabel":"string\u003cdate-time> | null"},"resolved_at":{"oneOf":[{"type":"string","description":"The date when the event was resolved either succeed or failed","format":"date-time","uniqueKey":"data.resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the event was resolved either succeed or failed","format":"date-time","uniqueKey":"data.resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.resolved_at","typeLabel":"string\u003cdate-time> | null"},"cancelled_at":{"oneOf":[{"type":"string","description":"The date when the event was cancelled","format":"date-time","uniqueKey":"data.cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the event was cancelled","format":"date-time","uniqueKey":"data.cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancelled_at","typeLabel":"string\u003cdate-time> | null"},"expired_at":{"oneOf":[{"type":"string","description":"The date when the event expired","format":"date-time","uniqueKey":"data.expired_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the event expired","format":"date-time","uniqueKey":"data.expired_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.expired_at","typeLabel":"string\u003cdate-time> | null"},"reversed_at":{"oneOf":[{"type":"string","description":"The date when the event was reversed","format":"date-time","uniqueKey":"data.reversed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the event was reversed","format":"date-time","uniqueKey":"data.reversed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reversed_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"PURCHASE","data":{},"fulfilled":true,"reserve":123,"queue_message_id":"\u003cstring>","rewarding_campaigns":"\u003carray>","status":"PENDING","result":{"wallet":{},"customer":{},"gift_card":[{"code":"\u003cstring>","reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","rewarded_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","expired_at":"2023-11-07T05:31:56Z","redeemed_at":"2023-11-07T05:31:56Z"}],"accumulations":[{"amount":123,"reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","campaign_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","issued_at":"2023-11-07T05:31:56Z","expiration_date":"2023-11-07T05:31:56Z","reservation_expires_at":"2023-11-07T05:31:56Z"}],"redemptions":[{"amount":123,"reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","campaign_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","issued_at":"2023-11-07T05:31:56Z","expiration_date":"2023-11-07T05:31:56Z","reservation_expires_at":"2023-11-07T05:31:56Z"}],"transactions":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"\u003cstring>","event_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","campaign_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","channel_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","store_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","funded_by":"MARKETING","event_type":"PURCHASE","reward_type":"POINTS","reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":123,"cost":123,"details":"\u003cstring>","type":"ACCUMULATION","receiver_id":"\u003cstring>","sender_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","issued_at":"2023-11-07T05:31:56Z","attributes":{"line":{"amount":123,"reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","campaign_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","issued_at":"2023-11-07T05:31:56Z","expiration_date":"2023-11-07T05:31:56Z","reservation_expires_at":"2023-11-07T05:31:56Z"},"campaign_name":"\u003cstring>"},"metadata":{}}],"customer_by_tier":[{}]},"issued_at":"2023-11-07T05:31:56Z","processing_at":"2023-11-07T05:31:56Z","resolved_at":"2023-11-07T05:31:56Z","cancelled_at":"2023-11-07T05:31:56Z","expired_at":"2023-11-07T05:31:56Z","reversed_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6a056255-8ffa-47dd-8555-e7e84f3c1717":{"description":"Invalid event. A redemption over the 24-hour cap returns: Cannot redeem {amount} {reward}. Only {left} left under the 24-hour redemption limit. Nothing is deducted and the event is stored as FAILED.","content":{"application/json":{"schema":{"required":["error","details"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","isRequired":true,"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"redemptionLimit":{"title":"redemptionLimit","value":{"error":"Internal validation failed","details":"Cannot redeem 50 points. Only 30 left under the 24-hour redemption limit."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e5fbaeb9-73b3-4320-8dec-e2c171b31efa":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bfa79d19-faf8-4b65-9f12-2bd5b6069d7f":{"url":"https://app.masivo.ai/api/storefront/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"trd","siteName":"Masivo","title":"Emit event - Masivo","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/behavior/events/post","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-18T17:21:49.985Z","originalFileLocation":"api-reference/behavior/events/post.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer\u0026#x27;s tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Masivo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Emit event - Masivo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer\u0026#x27;s tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Masivo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.masivo.ai/api-reference/behavior/events/post\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trd.mintlify.app/_mintlify/api/og/v2?division=Behavior\u0026amp;title=Emit+event\u0026amp;description=Create+a+behavior+event.+This+triggers+matching+campaigns+to+offer+rewards+to+the+customer.+Store%2C+channel%2C+and+product+scope+is+evaluated+against+the+event.+Ti\u0026amp;theme=8f8d98b752dbc21b97c2a726\u0026amp;signature=066762d825e528e067495c122bb8bbc0271234e05b6eff54ab7600ac6821f2fb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Emit event - Masivo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer\u0026#x27;s tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trd.mintlify.app/_mintlify/api/og/v2?division=Behavior\u0026amp;title=Emit+event\u0026amp;description=Create+a+behavior+event.+This+triggers+matching+campaigns+to+offer+rewards+to+the+customer.+Store%2C+channel%2C+and+product+scope+is+evaluated+against+the+event.+Ti\u0026amp;theme=8f8d98b752dbc21b97c2a726\u0026amp;signature=066762d825e528e067495c122bb8bbc0271234e05b6eff54ab7600ac6821f2fb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Masivo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9333ea\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.masivo.ai/api-reference/behavior/events/post\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/behavior/events/post.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.masivo.ai/#organization\",\"name\":\"Masivo\",\"url\":\"https://docs.masivo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/light.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d6c63ec91328f53e2881c4b8c6463002\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.masivo.ai#website\",\"name\":\"Masivo\",\"url\":\"https://docs.masivo.ai\",\"publisher\":{\"@id\":\"https://docs.masivo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.masivo.ai/api-reference/behavior/events/post#webpage\",\"url\":\"https://docs.masivo.ai/api-reference/behavior/events/post\",\"name\":\"Emit event\",\"description\":\"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer's tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\",\"dateModified\":\"2026-08-18T17:21:49.985Z\",\"isPartOf\":{\"@id\":\"https://docs.masivo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.masivo.ai/api-reference/behavior/events/post#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.masivo.ai/api-reference/behavior/events/post#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.masivo.ai/api-reference/auth/authorize/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Emit event\",\"item\":\"https://docs.masivo.ai/api-reference/behavior/events/post\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.masivo.ai/api-reference/behavior/events/post#apireference\",\"headline\":\"Emit event\",\"name\":\"Emit event\",\"description\":\"Create a behavior event. This triggers matching campaigns to offer rewards to the customer. Store, channel, and product scope is evaluated against the event. Tier scope is evaluated using the customer's tier at the start of event processing, before any tier transition produced by the event. null or an empty tiers array means no tier restriction.\",\"url\":\"https://docs.masivo.ai/api-reference/behavior/events/post\",\"mainEntityOfPage\":{\"@id\":\"https://docs.masivo.ai/api-reference/behavior/events/post#webpage\"},\"dateModified\":\"2026-08-18T17:21:49.985Z\",\"publisher\":{\"@id\":\"https://docs.masivo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.masivo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Masivo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Masivo","nav":{"global":{"anchors":[{"anchor":"Roadmap","icon":"map","href":"https://docs.masivo.ai/roadmap"},{"anchor":"Changelog","icon":"rocket","href":"https://docs.masivo.ai/changelog"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/2DgqGUej"}]},"versions":[{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Auth","pages":[{"title":"Authorize","openapi":"GET /auth/authorize","href":"/api-reference/auth/authorize/get"},{"title":"Request TOTP","openapi":"POST /auth/totp","href":"/api-reference/auth/totp/post"},{"title":"Verify TOTP","openapi":"GET /auth/totp/verify","href":"/api-reference/auth/totp/verify/get"}]},{"group":"Brands","pages":[{"title":"Get brands","openapi":"GET /brands","href":"/api-reference/brands/get"}]},{"group":"Platforms","pages":[{"title":"Get platforms","openapi":"GET /platforms","href":"/api-reference/platforms/get"}]},{"group":"Tiers","pages":[{"title":"Get tiers","openapi":"GET /tiers","href":"/api-reference/tiers/get"}]},{"group":"Rewards","pages":[{"title":"Get rewards","openapi":"GET /rewards","href":"/api-reference/rewards/get"},{"title":"Get reward","openapi":"GET /rewards/{id}","href":"/api-reference/rewards/[id]/get"},{"group":"Gift cards","pages":[{"title":"Get customer gift cards","openapi":"GET /customers/{id}/rewards/gift-cards","href":"/api-reference/rewards/gift-cards/get"},{"title":"Redeem gift card","openapi":"Delete /rewards/gift-cards/redeem","href":"/api-reference/rewards/gift-cards/redeem/delete"}]}]},{"group":"Customers","pages":[{"title":"Register customer","openapi":"POST /customers","href":"/api-reference/customers/post"},{"title":"Get customer by document or phone","openapi":"GET /customers","href":"/api-reference/customers/get"},{"title":"Get customer","openapi":"GET /customers/{id}","href":"/api-reference/customers/[id]/get"},{"title":"Update customer","openapi":"PATCH /customers/{id}","href":"/api-reference/customers/[id]/patch"},{"title":"Unregister customer","openapi":"DELETE /customers/{id}","href":"/api-reference/customers/[id]/delete"},{"title":"Update customers in bulk","openapi":"PATCH /customers/bulk","href":"/api-reference/customers/bulk/patch"},{"title":"Get customer consent","openapi":"GET /customers/{id}/consent","href":"/api-reference/customers/[id]/consent/get"},{"title":"Update customer consent","openapi":"PATCH /customers/{id}/consent","href":"/api-reference/customers/[id]/consent/patch"},{"title":"Update customer tags","openapi":"PATCH /customers/{id}/tags","href":"/api-reference/customers/[id]/tags/patch"},{"title":"Delete customer tags","openapi":"DELETE /customers/{id}/tags","href":"/api-reference/customers/[id]/tags/delete"},{"title":"Get customer punch-cards","openapi":"GET /customers/{id}/punch-cards","href":"/api-reference/customers/[id]/punch-cards/get"},{"title":"Get customer score streaks","openapi":"GET /customers/{id}/score-streaks","href":"/api-reference/customers/[id]/score-streaks/get"},{"title":"List in-app messages","openapi":"GET /customers/{id}/inapp-messages","href":"/api-reference/customers/[id]/inapp-messages/get"},{"title":"Log in-app message event","openapi":"POST /customers/{id}/inapp-messages/{messageId}/events","href":"/api-reference/customers/[id]/inapp-messages/[messageId]/events/post"},{"title":"Get customer news feed cards","openapi":"GET /customers/{id}/news-feed","href":"/api-reference/customers/[id]/news-feed/get"},{"title":"Log a news feed card event","openapi":"POST /customers/{id}/news-feed/{templateId}/events","href":"/api-reference/customers/[id]/news-feed/[templateId]/events/post"},{"title":"Identify anonymous customers","openapi":"PATCH /customers/{id}/identify/anonymous","href":"/api-reference/customers/[id]/identify/anonymous/patch"}]},{"group":"Contacts","pages":[{"title":"Search contacts","openapi":"GET /contacts","href":"/api-reference/contacts/get"},{"title":"Create contact","openapi":"POST /contacts","href":"/api-reference/contacts/post"},{"title":"Update contact by ID","openapi":"PUT /contacts/{id}","href":"/api-reference/contacts/[id]/put"},{"title":"Delete contact by ID","openapi":"DELETE /contacts/{id}","href":"/api-reference/contacts/[id]/delete"},{"title":"Migrate contacts","openapi":"POST /contacts/migrate","description":"Migrate contacts in bulk from an external system to Masivo. This endpoint allows you to import up to 10,000 contacts at once. Production accounts can send up to 15 requests every 5 seconds and 10,000 requests per hour to this endpoint.","href":"/api-reference/contacts/migrate/post"}]},{"group":"Campaigns","pages":[{"group":"Behavior","pages":[{"title":"Emit event","openapi":"POST /behavior/events","href":"/api-reference/behavior/events/post"},{"title":"Fulfill event","openapi":"PATCH /behavior/events/{eventId}/fulfill","description":"Fulfill a behavior event. This will redeem the event rewards and offer campaign rewards to the customer.","href":"/api-reference/behavior/events/[eventId]/fulfill/patch"},{"title":"Reverse event","openapi":"POST /behavior/events/{eventId}/reverse","href":"/api-reference/behavior/events/[eventId]/reverse/delete"},{"title":"Preview order","openapi":"PUT /events/redeem/preview","href":"/api-reference/events/redeem/preview/put"},{"title":"Identify customer","openapi":"PATCH /events/identify","href":"/api-reference/events/identify/patch"}]},{"group":"Coupons","pages":[{"title":"Redeem coupon","openapi":"POST /coupons/redeem","href":"/api-reference/coupons/redeem/post"},{"title":"Reverse coupon","openapi":"POST /coupons/reverse","href":"/api-reference/coupons/reverse/post"}]},{"group":"Referrals","pages":[{"title":"Request referral code","openapi":"POST /customers/{id}/referrals/request-code","href":"/api-reference/customers/[id]/referrals/request-code/post"}]},{"title":"Get campaign","openapi":"GET /campaigns/{id}","href":"/api-reference/campaigns/[id]/get"},{"title":"Update campaign","openapi":"PUT /campaigns/{id}","href":"/api-reference/campaigns/[id]/put"},{"title":"Get campaigns","openapi":"GET /campaigns","href":"/api-reference/campaigns/get"},{"title":"Create a new campaign","openapi":"POST /campaigns","href":"/api-reference/campaigns/post"}]},{"group":"Review forms","pages":[{"title":"Get form","openapi":"GET /review-forms/{id}","href":"/api-reference/review-forms/[id]/get"},{"title":"Create review","openapi":"POST /review-forms/{id}/reviews","href":"/api-reference/review-forms/[id]/reviews/post"},{"title":"List reviews","openapi":"GET /reviews","href":"/api-reference/reviews/get"}]},{"group":"Tickets","pages":[{"title":"List ticket pipelines","openapi":"GET /ticket-pipelines","href":"/api-reference/ticket-pipelines/get"},{"title":"List ticket closure forms","openapi":"GET /ticket-closure-forms","href":"/api-reference/ticket-closure-forms/get"},{"title":"Create ticket","openapi":"POST /tickets","href":"/api-reference/tickets/post"},{"title":"Get ticket","openapi":"GET /tickets/{id}","href":"/api-reference/tickets/[id]/get"},{"title":"Update ticket","openapi":"PATCH /tickets/{id}","href":"/api-reference/tickets/[id]/patch"},{"title":"List ticket assignees","openapi":"GET /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/get"},{"title":"Add ticket assignee","openapi":"POST /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/post"},{"title":"Remove ticket assignee","openapi":"DELETE /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/delete"},{"title":"List communication threads","openapi":"GET /communication/threads","href":"/api-reference/communication/threads/get"},{"title":"Create communication thread","openapi":"POST /communication/threads","href":"/api-reference/communication/threads/post"},{"title":"Get communication thread","openapi":"GET /communication/threads/{id}","href":"/api-reference/communication/threads/[id]/get"},{"title":"List communication messages","openapi":"GET /communication/threads/{id}/messages","href":"/api-reference/communication/threads/[id]/messages/get"},{"title":"Create communication message","openapi":"POST /communication/threads/{id}/messages","href":"/api-reference/communication/threads/[id]/messages/post"}]},{"group":"Transactions","pages":[{"title":"Customer transactions","openapi":"GET /customers/{id}/transactions","href":"/api-reference/customers/[id]/transactions/get"},{"title":"Account transactions","openapi":"GET /transactions","href":"/api-reference/transactions/get"}]},{"group":"Push","pages":[{"title":"Customer device token","openapi":"PATCH /customers/{id}/devices","href":"/api-reference/customers/[id]/devices/patch"},{"title":"Customer device token","openapi":"DELETE /customers/{id}/devices","href":"/api-reference/customers/[id]/devices/delete"},{"title":"Send customer push","openapi":"POST /push/customers/{id}/send","href":"/api-reference/push/customers/[id]/send/post"},{"title":"Schedule audience push","openapi":"POST /push/audiences/{id}/schedule","href":"/api-reference/push/audiences/[id]/schedule/post"}]},{"group":"In-app","pages":[{"title":"Get in-app capabilities","openapi":"GET /inapp/capabilities","href":"/api-reference/inapp/capabilities/get"}]},{"group":"Migrate","pages":[{"title":"Migrate customers","openapi":"POST /customers/migrate","href":"/api-reference/customers/migrate/post"},{"title":"Migrate devices tokens","openapi":"POST /customers/migrate/devices","href":"/api-reference/customers/migrate/devices/post"},{"title":"Migrate events","openapi":"POST /customers/migrate/events","href":"/api-reference/customers/migrate/events/post"},{"title":"Migrate transactions","openapi":"POST /customers/migrate/transactions","href":"/api-reference/customers/migrate/transactions/post"},{"title":"Revert migration","openapi":"DELETE /customers/migrate/revert","href":"/api-reference/customers/migrate/revert/delete"}]},{"group":"Maintenance","pages":[{"title":"Fulfill expired events","openapi":"POST /customers/fulfill_expired_events","href":"/api-reference/customers/fulfill_expired_events/post"}]}]},{"group":"Guides","pages":[{"title":"Integrate with Masivo","href":"/api-reference/guides/integrate-with-masivo"},{"title":"Register a customer","href":"/api-reference/guides/register-a-customer"},{"title":"Show customer data","href":"/api-reference/guides/show-customer-data"},{"title":"Validate rewards redemption","href":"/api-reference/guides/validate-rewards-redemption"},{"title":"Send an event","href":"/api-reference/guides/send-an-event"},{"title":"Submit reviews","href":"/api-reference/guides/submit-reviews"},{"title":"Redeem a coupon","href":"/api-reference/guides/redeem-a-coupon"},{"title":"Reverse a coupon","href":"/api-reference/guides/reverse-a-coupon"},{"title":"Modify customer balance arbitrarily","href":"/api-reference/guides/modify-customer-balance-arbitrarily"},{"title":"Migrate customers","href":"/api-reference/guides/migrate-customers"},{"title":"Setup webhooks","href":"/api-reference/guides/setup-webhooks"},{"title":"Integrate push notifications","href":"/api-reference/guides/integrate-push-notification"},{"title":"Integrate in-app messages","href":"/api-reference/guides/integrate-in-app-messages"},{"title":"Integrate deferred deep linking","href":"/api-reference/guides/integrate-deferred-deep-linking"},{"group":"Marketing automation","pages":[{"title":"FCM Token Management","href":"/api-reference/guides/fcm-token-management"},{"title":"Attribution Tracking","href":"/api-reference/guides/attribution-tracking"},{"title":"Customer Audience Enrollment","href":"/api-reference/guides/customer-audience-enrollment"},{"title":"Journey Triggers","href":"/api-reference/guides/journey-triggers"}]}]},{"group":"Resources","pages":[{"title":"Resource limits","href":"/api-reference/resources/resource-limits"}]}]}]}]},"basePath":"","title":"Emit event - Masivo","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}