Getting Started
Sending Emails
Encharge API
Transactional Email API
Advanced
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.
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.
1
{
2
"event": "added-tag-test",
3
"type": "tag",
4
"properties": {
5
"tag": "test"
6
},
7
"user": {
8
"id": "c1756f7d-8086-4704-ac73-b242857feb1a",
9
"email": "[email protected]"
10
},
11
"timestamp": 1562914373005
12
}
Copied!
Email Clicked
Email was delivered to person.
1
{
2
"event": "email-delivered",
3
"type": "email",
4
"properties": {
5
"emailId": 59969,
6
"flowId": "48918",
7
"flowName": "New Flow",
8
"emailName": "Welcome email"
9
},
10
"user": {
11
"id": "1ad75773-a8d9-4676-b2e8-d2beebf3742f",
12
"email": "[email protected]"
13
},
14
"timestamp": 1562914373005
15
}
Copied!
Person Updated
Field
company was changed from "Acme" to "Encharge".1
{
2
"event": "updatedUser",
3
"type": "updatedUser",
4
"properties": {
5
"changedFields": {
6
"company": {
7
"newValue": "Encharge",
8
"oldValue": "Acme"
9
},
10
},
11
"source": "manual"
12
},
13
"user": {
14
"id": "b361b760-f6c9-4b23-80a8-82a968987fb8",
15
"email": "[email protected]"
16
},
17
"timestamp": 1562914373005
18
}
19
Copied!
Last modified 26d ago
Copy link