Skip to content

Managing pages

Learn how to create, modify, and remove pages on Braze Docs. To create or reorder a section instead, see Sections. For general information about pages, see About content management.

Prerequisites

If you haven’t already, complete the steps for Contributing to Braze Docs.

Creating a page

Step 1: Create a new file

Open the relevant directory, then create a new Markdown file for your page.

1

PAGE_TITLE.md

Replace PAGE_TITLE with the title of your page, which should follow the Braze Docs Style Guide. Use all lowercase characters, remove special characters, and replace spaces with underscores (_). Your filename should be similar to the following:

  • Page title: Setting up your development environment for C++
  • File name: setting_up_your_development_environment_for_cpp.md

Step 2: Add a template

Copy and paste one of the following templates into your Markdown file. For more information, see Templates.

Basic template

You can use this template to create any page or section for Braze Docs. For an example, see Generating a preview. For guidelines on the documentation types used within the article, see Page types.

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

---
nav_title: NAV_TITLE
article_title: ARTICLE_TITLE
description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: reference
layout: OPTIONAL_LAYOUT_FILE
---

<!-- The title of your page, used to render the in-page title. -->
# ARTICLE_TITLE

<!-- The overview starts with a '>' character and discusses what will be covered. In an optional following paragraph, contextualize the topic at a high-level in an introduction. -->
> DESCRIPTION.

INTRODUCTION.

<!-- 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 optional, brief explanation of how the feature workflow looks. -->
## How it works

CONTENT.

<!-- Walk a user through integrating and turning on the feature. -->
 ## Integration
CONTENT.

<!-- A how-to guide with nested steps. -->
## TASK_TO_COMPLETE

<!-- Optional overview of the task. -->
CONTENT.

<!-- Action-oriented header that describes the step’s goal. -->
### Step 1: ACTION_TO_COMPLETE

<!-- Use number bullets or paragraphs to describe how to complete this action -->
CONTENT.

### Step 2: ACTION_TO_COMPLETE

CONTENT.
<!-- Optional references, such as supported data types, fields, definitions, and similar. -->
### REFERENCE_TO_ASSIST_WITH_ACTION

CONTENT.

<!-- For optional steps, add “(optional)” to the end of the header. -->
### Step 3: OPTIONAL_ACTION_TO_COMPLETE (optional)

CONTENT.
<!-- An optional section for what is supported. Add nested headers to be more specific. -->
## Supported data types / Supported attributes / Supported events / Supported ETC.
CONTENT.
<!-- An optional section with important considerations for users to review before using the feature. -->
## Considerations

CONTENT.

<!-- An optional section guiding users through troubleshooting common issues. -->
## Troubleshooting

### ISSUE_TO_TROUBLESHOOT
CONTENT.

Technology partner template

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

---
nav_title: NAV_TITLE
article_title: ARTICLE_TITLE
description: "SHORT_DESCRIPTION."
alias: /partners/PARTNER_NAME/
page_type: partner
search_tag: Partner
---

<!-- In most cases, the ARTICLE_TITLE will be your company name. If your tool requires several separate 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 concise 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 necessary 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 necessary steps. -->
## Customizing TOOL_NAME

### Step 1: ACTION_TO_COMPLETE

CONTENT.

### Step 2: ACTION_TO_COMPLETE

CONTENT.

<!-- A section outlining 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.

Writing content

Other than the Braze-specific syntax covered in this section, all content be written using standard Markdown syntax.

Cross-referencing

To reference a page hosted outside Braze Docs, use standard Markdown syntax.

1

[LINK_TEXT](FULL_URL)

To cross-reference a page hosted on Braze Docs, use the following Braze-specific syntax.

1

[LINK_TEXT]({{site.baseurl}}/SHORT_URL)

Adding images

To add images, place the image’s PNG file inside the relevant location within assets/img, then use the following syntax.

1

![ALT_TEXT.]({% image_buster /assets/img/DIRECTORY/IMAGE.png %})
Github   Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!