Templates
You can use these templates to create pages or sections on Braze Docs.
Read HTML comments like the following to learn more about each section in a template:
1
<!-- Here's an HTML comment! -->
important:
You can keep these comments in your file while writing, but you’ll need to remove them before publishing.
Available templates
Basic
You can use this template to create any page or section for Braze Docs. For an example, see Generating a preview.
Show template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
---
nav_title: NAV_TITLE
article_title: ARTICLE_TITLE
description: "SHORT_DESCRIPTION."
---
<!-- The title of your page, used to render the in-page title. -->
# ARTICLE_TITLE
<!-- The description starts with a '>' character and contains an overview of what will be covered. Optionally, in a following paragraph, you can contextualize the topic at a high-level. -->
> DESCRIPTION.
OPTIONAL_CONTEXT.
<!-- The prerequisites for this task. If no prerequisites are required, you can remove this section. -->
## Prerequisites
Before you start, you'll need to complete the following:
- ACTION_TO_COMPLETE
- ACTION_TO_COMPLETE
- ACTION_TO_COMPLETE
<!-- An example section. You may add subsections, images, and links as needed. -->
## SECTION_TITLE
CONTENT.
<!-- An example section with subsections. You may add addtional subsections, images, and links as needed. -->
## SECTION_TITLE
### Step 1: ACTION_TO_COMPLETE
CONTENT.
### Step 2: ACTION_TO_COMPLETE
CONTENT.
Technology partner
You can use this template to create technology partner documentation. For an example, see Scuba Analytics.
Show template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
---
nav_title: NAV_TITLE
article_title: ARTICLE_TITLE
description: "SHORT_DESCRIPTION."
alias: /partners/PARTNER_NAME/
page_type: partner
search_tag: Partner
layout: dev_guide
---
<!-- In most cases, the ARTICLE_TITLE will be your company name. If your tool requires several seperate pages on Braze Docs, you can add a relevant page descriptor to your title, such as "MyCompany Analytics." -->
# ARTICLE_TITLE
<!-- The description starts with a '>' character and contains an introduction to your company, a link to your main site, and a consice overview of your integration. In a following paragraph, highlight the the relationship between your company and Braze and how this partnership helps your customers. -->
> DESCRIPTION.
ADDITIONAL_INFORMATION.
<!-- Most partner integrations will require the following prerequisites. However, you may add additional prerequisites as needed. -->
## Prerequisites
Before you start, you'll need the following:
| Prerequisite | Description |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| A PARTNER_NAME account | A PARTNER_NAME account is required to take advantage of this partnership. |
| A Braze REST API key | A Braze REST API key with `users.track` permissions. <br><br> This can be created in the Braze dashboard from **Settings** > **API Keys**. |
| A Braze REST endpoint | [Your REST endpoint URL]({{site.baseurl}}/developer_guide/rest_api/basics/#endpoints). Your endpoint will depend on the Braze URL for your instance. |
{: .reset-td-br-1 .reset-td-br-2}
{% alert note %}
If you are using the [older navigation]({{site.baseurl}}/navigation), you can create an API key at **Developer Console** > **API Settings**.
{% endalert %}
<!-- An optional section you can use to outline the typical or atypical use cases for your integration. -->
## Use cases
CONTENT.
<!-- Create step-by-step instructions for integrating your tool with Braze. It's important to be concise and only outline the minimum neccesary steps. -->
## Integrating TOOL_NAME
CONTENT.
### Step 1: ACTION_TO_COMPLETE
CONTENT.
<!-- Use the "Make a post request", "Default behavior," and "Rate limit" sections to outline how users can make a POST request. If this information isn't required for your integration, you can remove these sections. -->
### Step 2: Make a post request
{% alert important %}
The following request uses curl. For better API request management, we recommend using an API client, such as Postman.
{% endalert %}
To upload your PARTNER_NAME data to Braze, make a POST request to `PARTNER_POST_URL` using the `application/json` content-type:
```bash
curl -X POST "PARTNER_POST_URL" \
-H "content-type: application/json" \
-d '{"braze_host":"BRAZE_API_ENDPOINT", \
"braze_api_key":"BRAZE_API_KEY", \
"PARTNER_host":"HOSTNAME", \
"PARTNER_token":"PARTNER_NAME_API_TOKEN"}'
```
Replace the following:
| Placeholder | Description |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `BRAZE_API_ENDPOINT` | The Braze REST endpoint URL of your current Braze instance. For more information, see [Rest API keys]({{site.baseurl}}/user_guide/administrative/app_settings/api_settings_tab/#rest-api-keys). |
| `BRAZE_API_KEY` | Your Braze REST API key with the `users.track` permission. |
| `HOSTNAME` | The hostname of your current PARTNER_NAME instance. |
| `PARTNER_NAME_API_TOKEN` | Your PARTNER_NAME API token. |
{: .reset-td-br-1 .reset-td-br-2}
#### Default behavior
CONTENT.
#### Rate limit
CONTENT.
<!-- An optional section you can use to outline additional customization steps. It's important to be concise and only outline the minimum neccesary steps. -->
## Customizing TOOL_NAME
### Step 1: ACTION_TO_COMPLETE
CONTENT.
### Step 2: ACTION_TO_COMPLETE
CONTENT.
<!-- A section outlinning how to use your integration with Braze. For example: how to access the data sent to Braze, or how to leverage your integration with Braze messaging. -->
## Using TOOL_NAME with Braze
### Step 1: ACTION_TO_COMPLETE
CONTENT.
### Step 2: ACTION_TO_COMPLETE
CONTENT.
Release notes
You can use this template to create release notes for Braze Docs. For an example, see January 9, 2024 release.
Show template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
nav_title: ARTICLE_TITLE
description: "This article contains release notes for DATE."
page_order: ORDER_NUMBER
page_type: reference
---
<!-- The title should include the date the release note is made live. For example, "February 21, 2024 release". -->
# MONTH DAY, YEAR release
<!-- Fill out the following four sections ("Data flexibility," "Unlocking creativity," "Robust channels," and "AI and ML automation") using the example section under the next HTML comment. -->
## Data flexibility
CONTENT.
## Unlocking creativity
CONTENT.
## Robust channels
CONTENT.
## AI and ML automation
CONTENT.
<!-- An example section containing "Release type" includes for each section. You may add addtional sections, subsections, includes, images, and links as needed. -->
## SECTION_TITLE
CONTENT.
### SUBSECTION_TITLE
{% multi_lang_include release_type.md release="Early access" %}
CONTENT.
### SUBSECTION_TITLE
{% multi_lang_include release_type.md release="General availability" %}
CONTENT.
### SUBSECTION_TITLE
{% multi_lang_include release_type.md release="Beta" %}
CONTENT.
### SUBSECTION_TITLE
CONTENT.
<!-- Use this section to highlight new Braze parternships by including an overview of each integration and a link to the related partner page on Braze Docs. -->
## New Braze partnerships
### PARTNER_NAME
CONTENT.
### PARTNER_NAME
CONTENT.
<!-- Use this section list any new SDKs or SDK updates that are already released. -->
## SDK updates
The following SDK updates have been released. Breaking updates are listed below; all other updates can be found by checking the corresponding SDK changelogs.
- [SDK_NAME](LINK_TO_GITHUB_CHANGELOG)
- OPTIONAL_CONTEXT.
- [SDK_NAME](LINK_TO_GITHUB_CHANGELOG)
- [SDK_NAME](LINK_TO_GITHUB_CHANGELOG)
Modifying a template
You can modify a template by following the steps outlined in these pages:
Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?