Journey events

If you publish a journey, Amazon Pinpoint can stream event data about the journey. This includes event data for any email, SMS, push, or custom messages that you send from the journey.

See the following for information about the data that Amazon Pinpoint streams:

• For email messages, see Email events.

• For SMS messages, see SMS events.

Sample event

The JSON object for a journey event contains the data shown in the following sample.

{
   "event_type":"_journey.send",
   "event_timestamp":1572989078843,
   "arrival_timestamp":1572989078843,
   "event_version":"3.1",
   "application":{
      "app_id":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "sdk":{

      }
   },
   "client":{
      "client_id":"d8dcf7c5-e81a-48ae-8313-f540cexample"
   },
   "device":{
      "platform":{

      }
   },
   "session":{

   },
   "attributes":{
      "journey_run_id":"edc9a0b577164d1daf72ebd15example",
      "journey_send_status":"SUCCESS",
      "journey_id":"546401670c5547b08811ac6a9example",
      "journey_activity_id":"0yKexample",
      "journey_activity_type": "EMAIL",
      "journey_send_status_message": "200", 
      "journey_send_status_code": "200"
   },
   "client_context":{
      "custom":{
         "endpoint":"{\"ChannelType\":\"EMAIL\",\"EndpointStatus\":\"ACTIVE\",\"OptOut\":\"NONE\",\"Demographic\":{\"Timezone\":\"America/Los_Angeles\"}}"
      }
   },
   "awsAccountId":"123456789012"
}

Journey event attributes

This section defines the attributes that are included in the event stream data that Amazon Pinpoint generates for a journey.

Attribute	Description
event_type	The type of event. For journey events, the value for this attribute is always _journey.send, which indicates that Amazon Pinpoint executed the journey.
event_timestamp	The time when the event was reported, shown as Unix time in milliseconds.
arrival_timestamp	The time when the event was received by Amazon Pinpoint, shown as Unix time in milliseconds.
event_version	The version of the event JSON schema. Tip Check this version in your event-processing application so that you know when to update the application in response to a schema update.
application	Information about the Amazon Pinpoint project that's associated with the event. For more information, see the Application table.
client	Information about the endpoint that's associated with the event. For more information, see the Client table.
device	Information about the device that reported the event. For journeys, this object is empty.
session	Information about the session that generated the event. For journeys, this object is empty.
attributes	Attributes that are associated with the journey and journey activity that generated the event. For more information, see the Attributes table.
client_context	Contains a custom object, which contains an endpoint property. The endpoint property contains the contents of the endpoint record for the endpoint that's associated with the event.
awsAccountId	The ID of the AWS account that was used to execute the journey.

Application

Includes information about the Amazon Pinpoint project that's associated with the event.

Attribute	Description
app_id	The unique ID of the Amazon Pinpoint project that reported the event.
sdk	The SDK that was used to report the event.

Client

Includes information about the endpoint that's associated with the event.

Attribute	Description
client_id	The ID of the endpoint.

Attributes

Includes information about the journey that generated the event.

Attribute	Description
journey_run_id	The unique ID of the journey run that generated the event. Amazon Pinpoint generates and assigns this ID automatically to each new run of a journey.
journey_send_status	Indicates the delivery status of the message that's associated with the event. Possible values include: SUCCESS – The message was successfully sent to the endpoint. FAILURE – The message wasn't sent to the endpoint because an error occurred. CUSTOM_DELIVERY_FAILURE – Custom delivery failed. FAILURE_PERMANENT – A permanent failure occurred when sending to the endpoint. Tip You can filter on events with FAILURE_PERMANENT status and journey_send_status_code set to 403 to determine if there is an access policy and role violation. For outbound campaigns with voice, these exceptions are typical to instances when the connect campaign execution role binding Amazon Pinpoint journeys to Amazon Connect campaigns is inadvertently deleted for in-flight journey executions. THROTTLED – Sending was throttled. UNSUPPORTED_CHANNEL – Channel is not supported. DAILY_CAP – The message wasn't sent to the endpoint because sending the message would exceed the maximum number of messages that the journey or project can send to a single endpoint during a 24-hour period. QUIET_TIME – The message wasn't sent because of quiet-time restrictions for the journey or project. QUIET_TIME_MISSING_TIMEZONE – The message wasn't sent because time zone estimation couldn't estimate a time zone for the endpoint and quiet-time is enabled.
journey_id	The unique ID of the journey that generated the event.
journey_activity_id	The unique ID of the journey activity that generated the event.
journey_activity_type	The event's journey activity type. This can be EMAIL, SMS, PUSH, CONTACT_CENTER, or CUSTOM. Note VOICE is not a supported journey activity type.
journey_send_status_message	The description of the status of the send event.
journey_send_status_code	The HTTP status code of the request.