Add activities to the journey

To set up an email activity

1. Choose Add activity.

2. For Add an activity, choose Send an email.

3. Under Select an email template to use for this activity, select Choose an email template, and then choose the email template for the message that you want participants to receive. Then, under Template version behavior, specify whether you want Amazon Pinpoint to automatically update the message to include any changes that you might make to the template before the message is sent. To learn more about these options, see Managing versions of message templates.

   Tip

   You can send yourself a preview of the message, even if your Amazon Pinpoint account doesn't contain an endpoint record for your email address. To send a preview, choose Send a test message.

4. For Sender email address, choose the email address that you want to send the message from. This list contains all the verified email addresses for your Amazon Pinpoint account in the current AWS Region. For information about verifying additional email addresses or domains, see Verifying email identities.

   Tip

   To display a friendly sender name for the message, choose the default email address for the project. A friendly sender name is the name that appears in participants' email clients when they receive the message. To change the default email address for the project or the friendly sender name for that address, update the project's settings for the email channel. To do this, choose Settings in the left navigation pane, and then choose Email. Then, enter the settings that you want.

5. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

6. When you finish, choose Save.

To set up a push notification activity

1. Choose Add activity.

2. For Add an activity, choose Send a push notification.

3. Under Choose a push notification template for this activity, select Choose a push notification template, and then choose the push notification template for the message that you want participants to receive. Then, under Template version behavior, specify whether you want Amazon Pinpoint to use the template version that is currently designated as active or the template version that was active when the journey was created. To learn more about these options, see Managing versions of message templates.

   Tip

   You can send yourself a preview of the message, even if your Amazon Pinpoint account doesn't contain an endpoint ID or device token that you specify. To send a preview, choose Send a test message.

4. (Optional) For Time to live, specify whether you want Amazon Pinpoint to use the default time to live (TTL) value or a custom value for each push notification service. By default, Amazon Pinpoint uses the maximum TTL value of each respective push notification service. You can also specify a custom TTL value for all push notification services. If the message delivery fails, the push notification service attempts to deliver the message for the amount of time that you specify in this setting. For information about specific time to live values, see Messages in the Amazon Pinpoint API Reference.

5. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

6. When you finish, choose Save.

To set up an SMS message activity

1. Choose Add activity.

2. For Add an activity, choose Send an SMS message.

3. Under Choose an SMS message template for this activity, select Choose an SMS message template, and then choose the SMS message template for the message that you want participants to receive. Then, under Template version behavior, specify whether you want Amazon Pinpoint to use the template version that is currently designated as active or the template version that was active when the journey was created. To learn more about these options, see Managing versions of message templates.

4. Choose Send a test message if you want to first test this activity. Test messages don't count against your daily sending limits, but you are charged for each message. When sending a test message you're prompted to optionally choose the origination number but required to choose a destination number.

   Note

   If your account is in the SMS sandbox, you can only send a test message to one of your verified destination numbers. If the destination number doesn't appear in the list, choose Manage numbers to add that new number. For more information about verifying destination numbers, see SMS sandbox in the Amazon Pinpoint SMS User Guide.

5. For Message type, choose one of the following:

   • Promotional – Non-critical messages, such as marketing messages.

   • Transactional – Critical messages that support customer transactions, such as one-time passwords for multi-factor authentication.

6. (Optional) If necessary, expand the Additional settings section to configure optional SMS-related settings. The Additional settings section contains two tabs:

   • On the SMS Settings tab you can configure the following settings:

     • Origination phone number – The phone number that messages will be sent from. This list contains all of the dedicated phone numbers that are present in your Amazon Pinpoint account.

     • Sender ID – An alphanumeric ID that identifies the sender of the SMS message. The Sender ID appears on your recipients' devices only if the recipient is in a country where Sender IDs are supported. If you specify a Sender ID in a journey activity, it overrides the default value for your account. To learn more about which countries support Sender IDs, see Supported countries and regions (SMS channel) in the Amazon Pinpoint SMS User Guide.

     Note

     You only need to set one of these values. If you specify both values, Amazon Pinpoint attempts to send the message using the dedicated origination phone number.

   • On the Regulatory Settings tab, you can configure settings that apply specifically to sending messages to recipients in India. If you send messages to recipients in India, you must specify a Sender ID, as well as both of the following values:

     • Entity ID – The ID that is associated with your company or brand, provided by TRAI during the Sender ID registration process.

     • Template ID – The ID that is associated with your message template. This value is also provided by TRAI during the Sender ID registration process.

     Note

     If you don't send messages to recipients in India, or if you send messages to India using International Long-Distance Operator routes, you don't need to specify the Entity ID and Template ID values.

     For more information about the regulatory requirements for sending SMS messages to India, see India sender ID registration process in the Amazon Pinpoint SMS User Guide.

7. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

8. When you finish, choose Save.

1. Choose Add activity.

2. For Add an activity, choose Send through a contact center.

3. Choose the Amazon Connect instance that you want to use.

4. Choose the Amazon Connect outbound campaign from the dropdown list.

5. (Optional) You can choose Build an Amazon Connect outbound campaign, which directs you to Amazon Connect.

6. For IAM role, complete one of the following steps:

   1. If you want to have Amazon Pinpoint create a role that allows it to pass phone numbers to Amazon Connect, select Automatically create a role. Then, for IAM role, enter a unique name for the new role that you're creating.

   2. If you've already created an IAM role that allows Amazon Pinpoint to pass phone numbers to Amazon Connect, select Choose an existing role. Then, for IAM role, select a role that contains the appropriate permissions.

7. (Optional) In Description, describe the purpose of the activity. When you save the activity, this text appears as the activity's label.

8. When you finish, choose Save.

To set up a custom message channel activity that calls a Lambda function

1. Choose Add activity.

2. For Add an activity, choose Send through a custom channel.

3. For Choose the method that you want to use to send messages, select Execute a Lambda function.

4. For Lambda function, choose the function that you want to execute.

5. (Optional) The Custom Data is for when endpoints are delivered to the custom channel, the custom data is in the payload as well. This field can contain up to 5000 alphanumeric characters.

6. For Specify the endpoint types that will receive this message, select the endpoint types that the custom channel applies to. By default, only the Custom endpoint type is selected. To add additional endpoint types, select Choose endpoint types.

   1. The lambda function can be used to evaluate which endpoints to include in the segment. For more information, see Customizing segments with AWS Lambda.

   2. The Custom Data is for when endpoints are delivered to the custom channel, the custom data is in the payload as well.

   Note

   Other endpoint types that arrive at this activity are sent through it, but only the endpoint types that you specify are sent to the Lambda function or webhook.

7. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

8. When you finish, choose Save.

To set up a custom message channel activity that uses a webhook URL

1. Choose Add activity.

2. For Add an activity, choose Send through a custom channel.

3. For Choose the method that you want to use to send messages, select Specify a webhook URL.

4. For Webhook URL, enter the address of the webhook that you want to execute. For more information about configuring webhooks, see Creating custom channels in Amazon Pinpoint in the Amazon Pinpoint Developer Guide.

5. (Optional) The Custom Data is for when endpoints are delivered to the custom channel, the custom data is in the payload as well. This field can contain up to 5000 alphanumeric characters.

6. For Specify the endpoint types that will receive this message, select the endpoint types that the custom channel applies to. By default, only the Custom endpoint type is selected. To add additional endpoint types, select Choose endpoint types.

   Note

   Other endpoint types that arrive at this activity are sent through it, but only the endpoint types that you specify are sent to the Lambda function or webhook.

7. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

8. When you finish, choose Save.

To set up a wait activity

1. Choose Add activity.

2. For Add an activity, choose Wait.

3. Choose one of the following options:

   • For a period of time – Choose this option if you want journey participants to remain on this activity for a certain amount of time. Then, enter the amount of time that you want journey participants to wait on this activity before they proceed to the next activity. You can specify a value that's as short as 1 hour or as long as 365 days.

   • Until a specific date – Choose this option if you want journey participants to remain on this activity until a specific date and time. Then, enter the date and time when journey participants should move to the next activity. You can choose any date and time that precedes the end date of the journey.

4. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

5. When you finish, choose Save.

To set up a yes/no split activity

1. Choose Add activity.

2. For Add an activity, choose Yes/no split.

3. For Select a condition type, choose one of the following options:

   • Segment – Choose this option to send all members of the chosen segment down the "Yes" path. Then, for Segments, choose a segment.

   • Event – Choose this option to send users down the "Yes" path based on their interactions with a previous step in this journey. Then, complete the following steps:

     1. For Events, select the messaging activity you want to split on:

     2. For Choose an activity, choose the message activity that the split should be applied to. Depending on the channel type of messaging activity you select you will have the following options on split on:

        • For Email here are the events you can select.

          • Send – Amazon Pinpoint accepted the message and will attempt to deliver it.

          • Delivered – The message was successfully delivered to the recipient.

          • Rejected – Amazon Pinpoint rejected the message because it contained a virus or malware.

          • Hard bounce – The email wasn't delivered to the recipient because of a permanent issue. For example, the recipient's email address might not exist anymore. When a message generates a hard bounce, Amazon Pinpoint doesn't attempt to re-deliver it.

          • Soft bounce – The email wasn't delivered to the recipient because of a temporary issue. For example, the recipient's inbox could be full, or their email provider might be experiencing a temporary issue. When a soft bounce occurs, Amazon Pinpoint attempts to re-deliver the message for a certain period of time. If the message still can't be delivered, the message becomes a hard bounce.

          • Complaint – The recipient received the email, but used the "Report spam" or similar button in their email client to report the message as unwanted.

            Note

            Amazon Pinpoint relies on complaint reports from email providers to generate complaint events. Some email providers give us these reports on a regular basis, while others send them infrequently.

          • Open – The recipient received the email and opened it.

            Note

            For Amazon Pinpoint to capture an Email open event, the recipient's email client has to download the images contained in the message. Many common email clients, such as Microsoft Outlook, don't download email images by default.

          • Click – The recipient received the email and followed one of the links contained in the body of the message.

          • Unsubscribe – The recipient received the email and used the "Unsubscribe" link to opt out of future messages.

        • For SMS here are the events you can select.

          • Send – Amazon Pinpoint attempted to send the message.

          • Delivered – Amazon Pinpoint received a confirmation the message was delivered.

          • Failed – An error occurred when delivering the message to the endpoint address.

          • Opt-out – The user who's associated with the endpoint address has opted out of receiving messages from you.

        • For Push here are the events you can select.

          • Send – Amazon Pinpoint attempted to send the message.

          • Opened notification – Amazon Pinpoint received a confirmation the message was opened by the user.

          • Received foreground – Amazon Pinpoint received a confirmation the message was received by the users device and displayed in the foreground.

          • Received background – Amazon Pinpoint received a confirmation the message was received by the users device and displayed in the background.

        • For Contact Center here are the events you can select.

          • Connected – Amazon Pinpoint received a confirmation the call was connected to an agent.

          • SIT tone – Amazon Pinpoint received a response the call gave back a busy tone.

          • Fax – Amazon Pinpoint received a response the call gave back a fax tone.

          • Voicemail beep – Amazon Pinpoint received a response the call gave back a voicemail with beep.

          • Voicemail no beep – Amazon Pinpoint received a response the call gave back a voicemail without beep.

          • Not answered – Amazon Pinpoint received a response the call was not answered and rang out without a voicemail.

        • Custom channel – For the custom channel activity you can define the response attribute and value you would like to split on. You must ensure this attribute and value is passed back to Amazon Pinpoint journeys in a way that can be read. For more information about how this response should be structured, see Creating custom channels in Amazon Pinpoint in the Amazon Pinpoint Developer Guide.

     3. Note

        (Optional) For custom channel activities you can split based on the Call to a function or webhook response. To configure this can you define:

        • Attribute – The name of the attribute to evaluate.

        • Value – The value used to determine in which way to split.

4. For Condition evaluation, choose when Amazon Pinpoint should evaluate the condition. You can choose from the following options:

   • Evaluate immediately – If you choose this option, Amazon Pinpoint checks to see if the event condition that you specified has been met the moment when the journey participant arrives on the activity.

   • Evaluate after – If you choose this option, Amazon Pinpoint waits for a specified period of time. After the specified period of time has elapsed, Amazon Pinpoint checks to see if the event condition that you specified has been met.

   • Evaluate on – If you choose this option, Amazon Pinpoint waits until a specific date and time. When that date and time arrives, Amazon Pinpoint checks to see if the event condition that you specified has been met.

5. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

6. When you finish, choose Save.

To set up a multivariate split activity

1. Choose Add activity.

2. For Add an activity, choose Multivariate split.

3. Determine how many different paths (branches) you want to create. Choose Add another branch to create additional paths.

4. On each branch, for Select a condition type, choose one of the following options:

   • Segment – Choose this option to send all members of the chosen segment down the path. Then, for Segments, choose a segment.

   • Event – Choose this option to send users down the path based on their interactions with a previous step in this journey. Then, complete the following steps:

     1. For Events, select the messaging activity you would like to split on.

     2. For Choose an activity, choose the message activity that the split should be applied to. Depending on the channel type of messaging activity you select you will have the following options on split on:

        • For Email here are the events you can select.

          • Send – Amazon Pinpoint accepted the message and will attempt to deliver it.

          • Delivered – The message was successfully delivered to the recipient.

          • Rejected – Amazon Pinpoint rejected the message because it contained a virus or malware.

          • Hard bounce – The email wasn't delivered to the recipient because of a permanent issue. For example, the recipient's email address might not exist anymore. When a message generates a hard bounce, Amazon Pinpoint doesn't attempt to re-deliver it.

          • Soft bounce – The email wasn't delivered to the recipient because of a temporary issue. For example, the recipient's inbox could be full, or their email provider might be experiencing a temporary issue. When a soft bounce occurs, Amazon Pinpoint attempts to re-deliver the message for a certain period of time. If the message still can't be delivered, the message becomes a hard bounce.

          • Complaint – The recipient received the email, but used the "Report spam" or similar button in their email client to report the message as unwanted.

            Note

            Amazon Pinpoint relies on complaint reports from email providers to generate complaint events. Some email providers give us these reports on a regular basis, while others send them infrequently.

          • Open – The recipient received the email and opened it.

            Note

            For Amazon Pinpoint to capture an Email open event, the recipient's email client has to download the images contained in the message. Many common email clients, such as Microsoft Outlook, don't download email images by default.

          • Click – The recipient received the email and followed one of the links contained in the body of the message.

          • Unsubscribe – The recipient received the email and used the "Unsubscribe" link to opt out of future messages.

        • For SMS here are the events you can select.

          • Send – Amazon Pinpoint attempted to send the message.

          • Delivered – Amazon Pinpoint received a confirmation the message was delivered.

          • Failed – An error occurred when delivering the message to the endpoint address.

          • Opt-out – The user who's associated with the endpoint address has opted out of receiving messages from you.

        • For Push here are the events you can select.

          • Send – Amazon Pinpoint attempted to send the message.

          • Opened notification – Amazon Pinpoint received a confirmation the message was opened by the user.

          • Received foreground – Amazon Pinpoint received a confirmation the message was received by the users device and displayed in the foreground.

          • Received background – Amazon Pinpoint received a confirmation the message was received by the users device and displayed in the background.

        • For Contact Center here are the events you can select.

          • Connected – Amazon Pinpoint received a confirmation the call was connected to an agent.

          • SIT tone – Amazon Pinpoint received a response the call gave back a busy tone.

          • Fax – Amazon Pinpoint received a response the call gave back a fax tone.

          • Voicemail beep – Amazon Pinpoint received a response the call gave back a voicemail with beep.

          • Voicemail no beep – Amazon Pinpoint received a response the call gave back a voicemail without beep.

          • Not answered – Amazon Pinpoint received a response the call was not answered and rang out without a voicemail.

        • Custom channel – For the custom channel activity you can define the response attribute and value you would like to split on. You must ensure this attribute and value is passed back to Amazon Pinpoint journeys in a way that can be read. For more information about how this response should be structured, see Creating custom channels in Amazon Pinpoint in the Amazon Pinpoint Developer Guide.

     3. For Choose a journey message activity and event choose Call to a function or webhook response.

        • Attribute – The name of the attribute to evaluate.

        • Value – The value used to determine which branch to traverse for the path.

   Repeat this step for each path in the activity.

5. For Condition evaluation, choose when Amazon Pinpoint should evaluate the condition. You can choose from the following options:

   • Evaluate immediately – If you choose this option, Amazon Pinpoint checks to see if the event condition that you specified has been met at the moment the journey participant arrives on the activity.

   • Evaluate after – If you choose this option, Amazon Pinpoint waits for a specified period of time. After the specified period of time has elapsed, Amazon Pinpoint checks to see if the event condition that you specified has been met.

   • Evaluate on – If you choose this option, Amazon Pinpoint waits until a specific date and time. When that date and time arrives, Amazon Pinpoint checks to see if the event condition that you specified has been met.

6. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

7. When you finish, choose Save.

To set up a holdout activity

1. Choose Add activity.

2. For Add an activity, choose Holdout.

3. For Holdout percentage, enter the percentage of journey participants who should be prevented from proceeding to the next activity in the journey.

4. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

5. When you finish, choose Save.

To set up a random split activity

1. Choose Add activity.

2. For Add an activity, choose Random split.

3. Determine how many different paths (branches) you want to create. Choose Add another branch to create each additional path.

4. In the field next to each branch, enter the percentage of journey participants who should be sent down that branch. The values that you specify have to be positive numbers, and they can't contain decimals. The sum of the values that you enter across all branches has to equal exactly 100%.

5. (Optional) For Description, enter text that describes the purpose of the activity. When you save the activity, this text appears as its label.

6. When you finish, choose Save.