Amazon Pinpoint · Schema
Activity
Specifies the configuration and other settings for an activity in a journey.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| CUSTOM | object | |
| ConditionalSplit | object | |
| Description | object | |
| object | ||
| Holdout | object | |
| MultiCondition | object | |
| PUSH | object | |
| RandomSplit | object | |
| SMS | object | |
| Wait | object | |
| ContactCenter | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-activity-schema.json",
"title": "Activity",
"description": "Specifies the configuration and other settings for an activity in a journey.",
"type": "object",
"properties": {
"CUSTOM": {
"allOf": [
{
"$ref": "#/components/schemas/CustomMessageActivity"
},
{
"description": "The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants."
}
]
},
"ConditionalSplit": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionalSplitActivity"
},
{
"description": "The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The custom description of the activity."
}
]
},
"EMAIL": {
"allOf": [
{
"$ref": "#/components/schemas/EmailMessageActivity"
},
{
"description": "The settings for an email activity. This type of activity sends an email message to participants."
}
]
},
"Holdout": {
"allOf": [
{
"$ref": "#/components/schemas/HoldoutActivity"
},
{
"description": "The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants."
}
]
},
"MultiCondition": {
"allOf": [
{
"$ref": "#/components/schemas/MultiConditionalSplitActivity"
},
{
"description": "The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default <i>Else</i> path) in a journey, based on conditions that you specify."
}
]
},
"PUSH": {
"allOf": [
{
"$ref": "#/components/schemas/PushMessageActivity"
},
{
"description": "The settings for a push notification activity. This type of activity sends a push notification to participants."
}
]
},
"RandomSplit": {
"allOf": [
{
"$ref": "#/components/schemas/RandomSplitActivity"
},
{
"description": "The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify."
}
]
},
"SMS": {
"allOf": [
{
"$ref": "#/components/schemas/SMSMessageActivity"
},
{
"description": "The settings for an SMS activity. This type of activity sends a text message to participants."
}
]
},
"Wait": {
"allOf": [
{
"$ref": "#/components/schemas/WaitActivity"
},
{
"description": "The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey."
}
]
},
"ContactCenter": {
"allOf": [
{
"$ref": "#/components/schemas/ContactCenterActivity"
},
{
"description": "The settings for a connect activity. This type of activity initiates a contact center call to participants."
}
]
}
}
}