Activity Stream

Activity Stream is an advanced feature that enables you to receive a real-time stream of all events that happen to people in your Encharge Account. You can store this activity in your data warehouse for further analytics.
How to get started?
Activity Stream is an add-on that is available for an extra fee. Please get in touch with your account manager or contact [email protected].
Please prepare your endpoint where events will be POSTed to. See below for a sample of an activity stream event.
You can supply Segment.com HTTP Tracking API source instead of your own endpoint.
The endpoint should return a success response (2XX code) in 2 seconds or less.
Each event will contain information (ID and email) about the person that triggered the event.
The timestamp that indicates when the event occured is attached to each event. The timestamp is UNIX time in milliseconds.
What activities are streamed?
Below you'll find a list of activities that Encharge will send. 
Please note that curly brackets indicated a value that will be replaced when the event is emitted. For example: added-tag-{tag} will become added-tag-tag1 when the person is tagged with "tag1".
Name: updatedUser 
Type: updatedUser
Person was updated. See changedFields in properties for changed fields, and their previous and new values.
Name: newUser 
Type: newUser
Person was created.
Name: unsubscribedUser 
Type: unsubscribedUser
Person unsubscribed from all emails.
Name: added-tag-{tag} 
Type: tag
Person was tagged. The tag is also passed as tag in properties.
Name: removed-tag-{tag} 
Type: tag
Person was untagged. The tag is also passed as tag in properties.
Name: page-visited 
Type: page
Person visited a page on your site (when Site Tracking is installed). URL is available in url in properties.
Name: form-submitted
Person submitted a from on your site (when Site Tracking is installed). URL is available in url in properties. Form data is available in form in properties.
Name: sms-sent 
Type: sms
Person was sent an SMS. Message is available as message in properties. 
Name: sms-failed 
Type: sms
Person couldn't be sent an SMS. Message is available as message in propertis. 
​
Email Events
In properties , each of these events will contain:
Email Id as emailId 
Flow ID (if applicable) as flowId.
Flow Name (if applicable) as flowName.
Email name as emailName.
Name: email-delivered 
Type: email
Person received an email. 
Name: email-open 
Type: email
Person opened an email. 
Name: email-click 
Type: email
Person clicked an email. Clicked link URL can be found in url in properties .
Name: email-reply 
Type: email
Person replied to an email. 
Name: email-blocked 
Type: email
Person couldn't receive an email (soft bounce).
Name: email-bounce 
Type: email
Person couldn't receive an email (hard bounce).
Name: email-dropped 
Type: email
Person couldn't receive an email because they are unsubscribed, have an invalid email address, or if they've received this marketing email before. See reason in properties .
Name: email-spamreport 
Type: email
Person reported this email as spam.
​
Flows Events
Name: performed-step:{stepId} 
Type: step
Person performed a step. You can find the step and the flow ID as stepId and flowId  in properties .
Name: errored-step:{stepId} 
Type: step
An error occured while the person was performing a step. You can find the step and the flow ID as stepId and flowId  in properties .
​
Example payloads
Tag added
Person was tagged.
{
  "event": "added-tag-test",
  "type": "tag",
  "properties": {
    "tag": "test"
  },
  "user": {
    "id": "c1756f7d-8086-4704-ac73-b242857feb1a",
    "email": "[email protected]"
  },
  "timestamp": 1562914373005
}
​
​
Email Clicked
Email was delivered to person.
{
  "event": "email-delivered",
  "type": "email",
  "properties": {
    "emailId": 59969,
    "flowId": "48918",
    "flowName": "New Flow",
    "emailName": "Welcome email"
  },
  "user": {
    "id": "1ad75773-a8d9-4676-b2e8-d2beebf3742f",
    "email": "[email protected]"
  },
  "timestamp": 1562914373005
}
​
Person Updated
Field company was changed from "Acme" to "Encharge".
{
  "event": "updatedUser",
  "type": "updatedUser",
  "properties": {
    "changedFields": {
      "company": {
        "newValue": "Encharge",
        "oldValue": "Acme"
      },
    },
    "source": "manual"
  },
  "user": {
    "id": "b361b760-f6c9-4b23-80a8-82a968987fb8",
    "email": "[email protected]"
  },
  "timestamp": 1562914373005
}
​

Transactional Email API - Previous

Sending to unsubscribed contacts

Last modified 3mo ago

Copy link

On this page

How to get started?

What activities are streamed?

Example payloads

How to get started?

What activities are streamed?

Email Events

​

Flows Events

Example payloads

Tag added

Email Clicked

Person Updated