Nudge Output

Schema for nudge output webhook integration

Property
Type
Description
nudgeUserId
String
Prediction Identifier
type
String
enum ["nudge"]
campaignId
String
Campaign Identifier
clientId
String
Client Identifier
maraxId
String
Marax identifier
userIdentities
Object
Available Identities. No property will be sent if no data exist in Marax system
userIdentities.clevertapId
String
Clevertap Identifier for user
userIdentities.userId
String
Client Identifier for user
userIdentities.email
String
User email
status
String
Status of the program 
trigger
String
Trigger based on event or time
channel
String
Type of channel
nudgeQueueDateTime
String
Nudge Queue time
nudgeExpiryDateTime
String
Expiry time for retrying sending nudge
content
Object
Object that defines the content for your message
content.$.title
String
Title content of your nudge message
content.$.body
String
Body content of your nudge message
content.$.image
String
Image associated with nudge
content.$.clickAction
String
​
content.$.textColour
String
Text color of the nudge message in Hex format
event
String
Allows you to target users based on an event they have performed.
event.$.name
String
Name of the event

Campaign Output

Next - SPECIFICATIONS

Inventory Schema

Last updated 9 months ago

Property	Type	Description
nudgeUserId	String	Prediction Identifier
type	String	enum ["nudge"]
campaignId	String	Campaign Identifier
clientId	String	Client Identifier
maraxId	String	Marax identifier
userIdentities	Object	Available Identities. No property will be sent if no data exist in Marax system
userIdentities.clevertapId	String	Clevertap Identifier for user
userIdentities.userId	String	Client Identifier for user
userIdentities.email	String	User email
status	String	Status of the program
trigger	String	Trigger based on event or time
channel	String	Type of channel
nudgeQueueDateTime	String	Nudge Queue time
nudgeExpiryDateTime	String	Expiry time for retrying sending nudge
content	Object	Object that defines the content for your message
content.$.title	String	Title content of your nudge message
content.$.body	String	Body content of your nudge message
content.$.image	String	Image associated with nudge
content.$.clickAction	String
content.$.textColour	String	Text color of the nudge message in Hex format
event	String	Allows you to target users based on an event they have performed.
event.$.name	String	Name of the event