Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.28 KB

IntegrationEventV2Request.md

File metadata and controls

35 lines (24 loc) · 2.28 KB

IntegrationEventV2Request

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`. [optional]
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]
responseContent List<ResponseContentEnum> Extends the response with the chosen data entities. Use this property to get as much data back as needed from one request instead of sending extra requests to other endpoints. [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]

Enum: List<ResponseContentEnum>

Name Value
CUSTOMERPROFILE "customerProfile"
TRIGGEREDCAMPAIGNS "triggeredCampaigns"
LOYALTY "loyalty"
EVENT "event"
AWARDEDGIVEAWAYS "awardedGiveaways"
RULEFAILUREREASONS "ruleFailureReasons"
CAMPAIGNELIGIBILITY "campaignEligibility"
ACHIEVEMENTS "achievements"
UNLOCKEDREWARDS "unlockedRewards"