Amazon Pinpoint · Schema

ConditionalSplitActivity

Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Condition object
EvaluationWaitTime object
FalseActivity object
TrueActivity object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-conditional-split-activity-schema.json Raw ↑
{
  "$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-conditional-split-activity-schema.json",
  "title": "ConditionalSplitActivity",
  "description": "<p>Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.</p> <note><p>To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html\">Integrating Amazon Pinpoint with your application</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p></note>",
  "type": "object",
  "properties": {
    "Condition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Condition"
        },
        {
          "description": "The conditions that define the paths for the activity, and the relationship between the conditions."
        }
      ]
    },
    "EvaluationWaitTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WaitTime"
        },
        {
          "description": "The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met."
        }
      ]
    },
    "FalseActivity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the activity to perform if the conditions aren't met."
        }
      ]
    },
    "TrueActivity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the activity to perform if the conditions are met."
        }
      ]
    }
  }
}