-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8315 from braze-inc/partner-doc-seen-nonfork
New partner doc: SEEN
- Loading branch information
Showing
4 changed files
with
133 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
127 changes: 127 additions & 0 deletions
127
_docs/_partners/message_personalization/dynamic_content/seen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
--- | ||
nav_title: SEEN | ||
article_title: SEEN | ||
description: "SEEN’s personalized videos has helped companies reach unmatched attention and engagement, throughout their customer journey." | ||
alias: /partners/seen/ | ||
page_type: partner | ||
search_tag: Partner | ||
--- | ||
|
||
# SEEN | ||
|
||
> [SEEN’s](https://seen.io/) personalized videos has helped companies reach unmatched attention and engagement, throughout their customer journey. Personalize videos with SEEN in three simple steps:<br>1. Design a video around your data.<br>2. Personalize it at scale in the cloud.<br>3. Distribute it where it works best. | ||
## Use cases | ||
|
||
SEEN offers automated video personalization across the entire the customer journey. Common uses include Onboarding, Loyalty, Sign-ups/Conversion, and Win-back/Anti-churn. | ||
|
||
## Prerequisites | ||
|
||
Before you start, you'll need the following: | ||
|
||
| Prerequisite | Description | | ||
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | ||
| A SEEN campaign | A SEEN campaign is required to take advantage of this partnership. | | ||
| Data source | You'll need to send data to SEEN to personalize your videos. Make sure you have all relevant data available in Braze, and that you pass data with **braze_id** as the identifier. | | ||
| Braze Data Transformation Webhook URL | Braze Data Transformation will be used to reformat the incoming data from SEEN so it can be accepted by Braze’s /users/track endpoint. | | ||
|
||
## Rate limit | ||
|
||
The SEEN API currently accepts 1000 calls per hour. | ||
|
||
## Integrating SEEN with Braze | ||
|
||
In the following example, we will be sending users data to SEEN for video generation, and receiving a unique landing page link and a unique, personalized thumbnail back to Braze for distribution. This example uses a POST webhook to send data to SEEN, and data transformation to receive the data back to Braze. If you have multiple video campaigns with SEEN, repeat the process to connect Braze with all video campaigns. | ||
|
||
{% alert tip %} | ||
If you experience any issues, you can reach out to your Customer Success Manager at SEEN for assistance. | ||
{% endalert %} | ||
|
||
### Step 1: Create a webhook campaign | ||
|
||
Create a new [Webhook Campaign](https://www.braze.com/docs/user_guide/message_building_by_channel/webhooks) in Braze. Give your campaign a name, then refer to the following table to compose your webhook: | ||
|
||
{% raw %} | ||
<table> | ||
<thead> | ||
<tr> | ||
<th><strong>Field</strong></th> | ||
<th><strong>Details</strong></th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><strong>Webhook URL</strong></td> | ||
<td>Use the following webhook URL. You will receive your <code>campaign_slug</code> from SEEN to call the correct endpoint.<br><br><code>https://api.seen.io/v1/campaigns/{campaign_slug}/receivers/</code></td> | ||
</tr> | ||
<tr> | ||
<td><strong>HTTP Method</strong></td> | ||
<td>Use the <code>POST</code> method.</td> | ||
</tr> | ||
<tr> | ||
<td><strong>Request body</strong></td> | ||
<td>Enter your request body in raw text similar to the following.<br><br><pre><code>[ | ||
{ | ||
"first_name":"{{${first_name}}}", | ||
"last_name":"{{${last_name}}}", | ||
"email":"{{${email_address}}}", | ||
"customer_id":"{{${braze_id}}}" | ||
} | ||
]</code></pre><br>For more information, see <a href="https://docs.seen.io/api-documentation/ntRoJJ3rXoHzFXhA94JiHB/overview/tvy2F5tS3JRM7DfcHwz5fK#request-content">SEEN API</a>.</td> | ||
</tr> | ||
<tr> | ||
<td><strong>Request headers</strong></td> | ||
<td>Use the following information to fill out your request headers:<br>- <strong>Authorization:</strong> <code>Token {token}</code><br>- <strong>Content-Type:</strong> <code>application/json</code><br><br>You will receive your Authentication Token from SEEN.</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
{% endraw %} | ||
{: .reset-td-br-1 .reset-td-br-2} | ||
|
||
You can now test the webhook with a user by switching to the **Test** tab. | ||
|
||
If everything works as intended, go to Braze and set the rate at which the campaign sends to 10 **messages per minute**. This ensures that you won't exceed the SEEN's rate limit of 1000 calls per hour. | ||
|
||
### Step 2: Create data transformation | ||
|
||
1. Create new [Custom Attribute](https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/#managing-custom-attributes) fields for `landing_page_url` and `email_thumbnail_url`. These are the two attributes we will be using in this example. | ||
2. Open [Data Transformation](https://www.braze.com/docs/user_guide/data_and_analytics/data_transformation/creating_a_transformation/#prerequisites) tool under **Data Settings**, and select **Create transformation**. | ||
3. Give your transformation a name, then choose **Start from scratch** and set **Destination** to **POST: Track users**. | ||
4. Select **Share your Webhook URL with SEEN**. | ||
5. You can use the code below as the starting point for the transformation: | ||
|
||
```javascript | ||
let brazecall = { | ||
"attributes": [ | ||
{ | ||
"braze_id": payload.customer_id, | ||
"_update_existing_only": true, | ||
"landing_page_url": payload.landing_page_url, | ||
"email_thumbnail_url": payload.email_thumbnail_url | ||
} | ||
] | ||
}; | ||
return brazecall; | ||
``` | ||
{% alert note %} | ||
If you want to include other data, make sure to include those as well. Remember to discuss with SEEN as well so that the callback payload includes all needed fields. | ||
{% endalert %} | ||
|
||
{: start="6"} | ||
6. Send a test payload to the provided endpoint. If you want to use the callback payload defined in [the SEEN documentation](https://docs.seen.io/api-documentation/ntRoJJ3rXoHzFXhA94JiHB/callbacks/k9DEbcgkq3Vr2pxbHyPQbp), you can send this yourself via [Postman](https://www.postman.com/) or another similar service: | ||
|
||
```json | ||
{ | ||
"customer_id": "101", | ||
"campaign_slug": "onboarding", | ||
"landing_page_url": "your.subdomain.com/v/12345", | ||
"video_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/output.m3u8", | ||
"thumbnail_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/thumbnail.jpg", | ||
"email_thumbnail_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/email_thumbnail.jpg" | ||
|
||
} | ||
``` | ||
|
||
{: start="7"} | ||
7. Select **Validate** to make sure everything works as intended. | ||
8. If everything worked as intended, select **Save** and **Activate**. |