Amazon Pinpoint Connector Setup Guide

API information

This connector uses the following vendor API:

API Name: Amazon Pinpoint API
API Version: v1
API Endpoint: https://pinpoint.us-east-1.amazonaws.com
Documentation: Amazon Pinpoint Documentation

Connector Actions

Action name	Visitor profile	Event data
Send Message	✓	✓
Send Push Notification	✓	✓
Send Template	✓	✓
Put Event	✓	✓
Update Endpoint	✓	✓

Configure Settings

Go to the connector marketplace and add a new connector. For more information, see About connectors.

After adding the connector, configure the following settings:

Access Key
- (Required) Provide your IAM User’s access key
- Associated IAM policy (for either IAM User or Assumed Role) must grant mobiletargeting:*, ses:*, sms-voice:\* permissions.
- For additional information, see: Amazon Pinpoint.
Secret Key
- (Required) Provide your IAM User’s secret key
Region
- (Required) Select region.
Assume Role: ARN
- (Optional) Provide Amazon Resource Name (ARN) of role to assume.
- Example: arn:aws:iam::222222222222:role/myrole
- For additional information, see: Switching to an IAM Role.
Assume Role: Session Name
- (Optional) Provide identifier for assumed role session.
Assume Role: External ID
- (Optional) Provide external identifier.
- For more information, see: How to Use an External ID.

Action Settings - Parameters and Options

Click Continue to configure the connector actions. Enter a name for the action and select the action type from the list.

Action - Send Message

Parameters

Parameter	Description
Application Id	(Required) The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Message Type	Message Type Options are Email, SMS, or Voice. Addresses (Template), Endpoints (Template) or Destination is required and only one of each is permitted. The fields Destination, Body, and Title are used to build an Addresses (Template). SMS Body for the SMS message type is required. Valid values for Message type are `TRANSACTIONAL` or `PROMOTIONAL`.
Template Variables	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, `{{SomeTemplateName}}`.
Charset	Character set mapping for the message content.
Html Part	Only one of Text Part or HTML part is permitted.
Subject	(Required) Subject of the email.
Text Part	Text or HTML. Use all text or all HTML.
Raw Email	Used only when Type=Email is selected. The email message, represented as a raw MIME message. The entire message must be base64-encoded.

Action - Send Push Notification

Parameters

Parameter	Description
Application ID	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Push Notification Type	Push Notification Type. Type in custom or select ADM, AMPS, BAIDU, or GCM.
Template Variables	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	O(Optional) Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, `{{SomeTemplateName}}`.

Action - Send Template

Parameters

Parameter	Description
Application Id	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Template Type	Template Type Options are Email, Push, SMS, Voice, or Custom.
Addresses (Template)	Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template).
Context (Template)	Object An object that maps custom attributes to attributes for the address and is attached to the message. Attributes are case-sensitive. For a push notification, this payload is added to the `data.pinpoint` object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
Destination	Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template).
Endpoints (Template)	Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template).
Name	String The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
TraceId	String The unique identifier for tracing the message. This identifier is visible in message events.
Version	String The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of version and version identifiers for a template, use the Template Versions resource. If you do not specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of the template most recently reviewed and approved for use, which is not always the latest version.
Template Variables	(Optional) Provide template variables as data input for templates. For more information, see About connector templates. Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header. or Body Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, `{{SomeTemplateName}}`.

Action - Put Event

Parameters

Parameter	Description
Application Id	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
App Package Name	String The package name of the app recording the event.
App Title	String The title of the app recording the event.
App Version Code	String The version number of the app recording the event.
Client Sdk Version	String The version of the SDK running on the client device.
Event Type	(Required) String The name of the event.
Sdk Name	String The name of the SDK being used to record the event.
Timestamp	String The date and time when the event occurred, in ISO 8601 format.
Event Attributes	Object One or more custom attributes associated with the event.
Event Metrics	Object One or more custom metrics associated with the event.
Duration	Integer The duration of the session, in milliseconds.
Id	(Required) String The unique identifier for the session.
Start Timestamp	String The date and time the session began.
Stop Timestamp	String The date and time the session ended.
Address	String The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
Demographic App Version	String The version of the app associated with the endpoint.
Demographic Locale	String The locale of the endpoint. Format is the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Demographic Make	String The manufacturer of the endpoint device. Example: Apple, Samsung
Demographic Model	String The model name or number of the endpoint device. Example: iPhone, SM-G900F
Demographic Model Version	String The model version of the endpoint device.
Demographic Platform	String The platform of the endpoint device. Example: ios
Demographic Platform Version	String The platform version of the endpoint device.
Demographic Timezone	String The time zone of the endpoint. Specified as a `tz` database name value, such as America/Los_Angeles.
Effective Date	String The date and time when the endpoint was last updated, in ISO 8601 UTC format.
Endpoint ID	Required
Endpoint Status	String Specifies whether to send messages or push notification to the endpoint. Valid values are: ACTIVE: Messages are sent to the endpoint. INACTIVE: Messages are not sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update and existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address, as specified by the `address` property.
Location City	String The name of the city where the endpoint is located.
Location Country	String Country is the two-character code for the country or region where the endpoint is located, in ISO 3166-1 alpha-2 format. Example: en_US for the United States
Location Latitude	Number The latitude coordinate for the endpoint location, rounded to one decimal place.
Location Longitude	Number The longitude coordinate for the endpoint location, rounded to one decimal place.
Location Postal Code	String The postal or zip code for the area where the endpoint is located.
Location Region	String The name of the region where the endpoint is located. For locations in the United States, the value is the name of a state.
Request Id	String The unique identifier for the request to create or update the endpoint.
User Id	String The unique identifier for the user.
Endpoint Attributes	One or more custom attributes that describe the endpoint.
Endpoint Metrics	One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Endpoint User Attributes	One or more custom attributes that describe the user by associating a name with an array of values.
Endpoint Channel Type	The channel used when sending messages or push notifications to the endpoint.
Endpoint OptOut	Specifies whether the user associated with the endpoint has opted out of receiving messages and push notifications from you.

Action - Update Endpoint

Parameters

Parameter	Description
Application Id	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Address	String The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
Demographic App Version	String The version of the app associated with the endpoint.
Demographic Locale	String The locale of the endpoint. Format is the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
Demographic Make	String The manufacturer of the endpoint device. Example: Apple, Samsung
Demographic Model	String The model name or number of the endpoint device. Example: iPhone, SM-G900F
Demographic Model Version	String The model version of the endpoint device.
Demographic Platform	String The platform of the endpoint device. Example: ios
Demographic Platform Version	String The platform version of the endpoint device.
Demographic Timezone	String The time zone of the endpoint. Specified as a `tz` database name value, such as America/Los_Angeles.
Effective Date	Effective date in ISO 8601 UTC format.
Endpoint Status	String Specifies whether to send messages or push notification to the endpoint. Valid values are: ACTIVE: Messages are sent to the endpoint. INACTIVE: Messages are not sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update and existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address, as specified by the `address` property.
Id	(Required) String The unique identifier for the session.
Location City	String The name of the city where the endpoint is located.
Location Country	Location country Country is the two-character code, in ISO 369-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. Example: en_US for the United States
Location Latitude	Number The latitude coordinate for the endpoint location, rounded to one decimal place.
Location Longitude	Number The longitude coordinate for the endpoint location, rounded to one decimal place.
Location Postal Code	String The postal or zip code for the area where the endpoint is located.
Location Region	String The name of the region where the endpoint is located. For locations in the United States, the value is the name of a state.
Request Id	String The unique identifier for the request or response.
User Id	String The unique identifier for the user.
Endpoint Attributes	One or more custom attributes that describe the endpoint by associating a name with an array of values.
Endpoint Metrics	One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Endpoint User Attributes	One or more custom attributes that describe the user by associating a name with an array of values.
Endpoint Channel Type	The channel used when sending messages or push notifications to the endpoint.
Endpoint OptOut	Specifies whether the user associated with the endpoint has opted out of receiving messages and push notifications from you. Valid values are ALL or NONE.