Skip to content

[Partner Name]

Welcome to the Partner Page Template! Here, you’ll find everything you need to create your own partner page. In this first section, you should describe the partner in the first paragraph in a sentence or two. Also, include a link to that partner’s main site.

In the second paragraph, you should explore and explain the relationship between Braze and this partner. This paragraph should explain how Braze and this partner work together to tighten the bond between the Braze User and their customer. Explain the “elevation” that occurs when a Braze User integrates with or leverages this partner and their services.

Requirements or Prerequisites

This section is all about what you need to integrate with the partner and start using their services. The best way to deliver this information is with a quick instructional paragraph that describes any non-technical important details of “need to know” information, like whether or not your integration will be subject to additional security checks or clearances. Then, you should use a chart to describe the technical requirements of the integration.

Requirement Origin Access Description
Braze App Group REST API Key Braze platform Manage Settings > Settings Page This description should tell you what to do with the App Group REST API Key.
Braze API Endpoint Braze platform Check out our listed endpoints or open a support ticket. Description pending.

[Type of Integration] Integration

This is where you break down the integration into steps. Do not just write endless paragraphs - these are technical documents which will be used by marketers and developers alike to get the integration up and running. Your only goal for this section is to write descriptive documentation that helps the Braze User get the job done. By ‘Type of Integration’ in the section title, we mean to indicate whether or not this is a Side-by-Side integration, server-to-server, or Out-of the Box. This enables you to have multiple Integration Sections if there is more than one way to integrate with this partner.

If this is a Currents Integration, this page should be located in the Currents section, and a corresponding Nav Page should be build that redirects to that location in Currents.

Step 1: This Is a Short Description of Step One

Just break this down, including any code as necessary. Remember that you can offer several different sets of code - there’s no need to only offer one way to integrate.

Step 2: This Step Will Describe Images

You have the option to put images in your documentation, so we recommend you do and do so mindfully.

Code Sample

If you’re explaining a technical concept, note that here and show a code sample.

1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
</head>
<body>

<h1>My First Heading</h1>
<p>My first paragraph.</p>

</body>
</html>

Make sure you define parameters or elements that users might have to adjust from the code sample. Many users will just copy and paste.

Variable Description
Page Title You can title your page anything. You have to have this.
My First Heading We recommend putting this in caps. This is also optional.

Step 3: How Many Steps

Outline through usage of the integration - especially if it means inserting Liquid into our message composer.

Customization

This is an optional section. Here, you could outline any specific ways to customize your integration between the two partners.

Using This Integration

This should describe how to use the integration - let your reader know if they need to push a few buttons or if they don’t need to do anything at all after the integration.

Step 1: This Is a Short Description of Step One

Just your typical step by step how to.

Code Sample

If you’re explaining a technical concept, note that here and show a code sample.

1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
</head>
<body>

<h1>My First Heading</h1>
<p>My first paragraph.</p>

</body>
</html>

Make sure you define parameters or elements that users might have to adjust from the code sample. Many users will just copy and paste.

Variable Description
Page Title You can title your page anything. You have to have this.
My First Heading We recommend putting this in caps. This is also optional.

Use Cases

This can be a critical part of your documentation. Though this is optional, this is a good place to outline typical or even novel use cases for the integration. This can be used as a way to sell or upsell the relationship - it provides context, ideas, and most importantly a way to visualize the capabilities of the integration.

WAS THIS PAGE HELPFUL?
New Stuff!