Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.8 KB

IntegrationEventV3Request.md

File metadata and controls

37 lines (26 loc) · 2.8 KB

IntegrationEventV3Request

Properties

Name Type Description Notes
profileId String ID of the customer profile set by your integration layer. Note: If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.
storeIntegrationId String The integration ID of the store. You choose this ID when you create a store. [optional]
evaluableCampaignIds List<Long> When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. [optional]
type String The name of the event. Must be a custom event, not a built-in event.
attributes Object Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See creating custom attributes. [optional]
integrationId String The unique ID of the event. Only one event with this ID can be registered.
connectedSessionId String The ID of the session to reference. The session must be in `closed` state. Otherwise, the API call will fail. [optional]
referralCode String The referral code submitted with the event. The endpoint does not validate the code, and submitting a code does not redeem it. Use the &quot;Referral code is valid&quot; condition in the Rule Builder to validate and redeem the code, or &quot;Referral code is valid (without redemption)&quot; to validate without redeeming. [optional]
loyaltyCards List<String> Identifiers of the loyalty cards used during this event. [optional]
rewardIntegrationIds List<String> The integration IDs of the unlocked rewards that can be used in this event. [optional]
responseContent List<ResponseContentEnum> Optional list of requested information to be present on the response related to the tracking custom event. [optional]

Enum: List<ResponseContentEnum>

Name Value
ADVANCEDEVENT "advancedEvent"
AWARDEDGIVEAWAYS "awardedGiveaways"
CUSTOMERPROFILE "customerProfile"
LOYALTY "loyalty"
REFERRAL "referral"
RULEFAILUREREASONS "ruleFailureReasons"
TRIGGEREDCAMPAIGNS "triggeredCampaigns"
UNLOCKEDREWARDS "unlockedRewards"