Skip to content

Commit ba40e23

Browse files
authored
Minor rewording, link added to reddit ads + casing/ backtick fixes
1 parent 4750def commit ba40e23

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

src/connections/destinations/catalog/actions-webhook-extensible/reddit-ads-audience-integration-recipe.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
title: Reddit Ads (Audience) Integration Recipe
33
---
44

5-
This recipe will guide you through setting up a custom destination for Reddit Ads (Audiences) using Twilio Segment's Extensible Webhooks feature. By following these steps, you will be able to integrate your data source with Reddit Ads (Audiences).
5+
This recipe will guide you through setting up a custom destination for [Reddit Ads (Audiences)](https://ads.reddit.com/){:target="_blank"} using Twilio Segment's [Extensible Webhooks](https://segment.com/docs/connections/destinations/catalog/actions-webhook-extensible/){:target="_blank"} feature. By following these steps, you will be able to integrate your data source with Reddit Ads (Audiences).
66

77
## Prerequisites
88

99
To integrate Reddit Ads with Segment, ensure you have the following:
1010

11-
A Segment account: an account with the Extensible Webhooks feature enabled (private beta access).
12-
A Reddit Ads (Audiences) account: an active account or API access to Reddit Ads (Audiences).
13-
Authentication credentials: necessary credentials for authentication, for example, API keys and tokens.
14-
Data mapping information: knowledge of the data fields required by Reddit Ads (Audiences).
11+
- A Segment account: an account with the Extensible Webhooks feature enabled (private beta access).
12+
- A Reddit Ads (Audiences) account: an active account or API access to Reddit Ads (Audiences).
13+
- Authentication credentials: necessary credentials for authentication, for example, API keys and tokens.
14+
- Data mapping information: knowledge of the data fields required by Reddit Ads (Audiences).
1515

1616
## Getting started
1717

18-
### 1. Configure Extensible Webhook as a destination
18+
### 1. Configure Extensible Webhooks as a destination
1919

2020
1. In your Segment workspace, navigate to **Connections** > **Catalog** > **Destinations**.
21-
2. Use the search bar to search for **Extensible Webhook** and select **Add destination**.
21+
2. Use the search bar to search for "Extensible Webhooks" and select **Add destination**.
2222

2323
### 2. Select the data source
2424

@@ -36,8 +36,8 @@ When creating your app, specify the following details:
3636
- Description (optional): Add a brief description of the integration.
3737
- Endpoint URL: Provide the webhook URL or endpoint provided by Reddit Ads (Audiences).
3838

39-
> info: Redirect URI
40-
The redirect URI used when creating a Reddit web app is https://app.segment.com/oauth-service/webhook/callback.
39+
> info "Redirect URI"
40+
> The redirect URI used when creating a Reddit web app is `https://app.segment.com/oauth-service/webhook/callback`.
4141
4242
### 4. Select the authentication type
4343

@@ -47,11 +47,11 @@ To set up OAuth:
4747

4848
1. Go to **Authentication Method** and select **OAuth 2.0**.
4949
2. Enter the following credentials as required:
50-
- Client ID: provided by the Reddit web app
51-
- Secret: provided by the Reddit web app
52-
- Authorize URL: https://www.reddit.com/api/v1/authorize
53-
- Token URL: https://www.reddit.com/api/v1/access_token
54-
- Refresh URL: https://www.reddit.com/api/v1/access_token
50+
- Client ID: This can be found in your the Reddit web app.
51+
- Secret: This can be found in your the Reddit web app.
52+
- Authorize URL: `https://www.reddit.com/api/v1/authorize`
53+
- Token URL: `https://www.reddit.com/api/v1/access_token `
54+
- Refresh URL: `https://www.reddit.com/api/v1/access_token`
5555
- Scope: To update Audiences, you will need to add ‘adsedit’ as a scope. To add multiple scopes, separate the values by commas.
5656

5757
You can also find the Authorize URL, Token URL, and Refresh URL in the [Reddit documentation](https://ads-api.reddit.com/docs/v3/operations/Update%20Custom%20Audience%20Users){:target="_blank"}.
@@ -63,7 +63,7 @@ You can also find the Authorize URL, Token URL, and Refresh URL in the [Reddit d
6363

6464
#### Data transformation
6565

66-
The Reddit Custom Audience API expects data in a nested format. To format the payload correctly, you will have to write an insert function that appends a new property called “body” (for example).
66+
The Reddit Custom Audience API expects data in a nested format. To format the payload correctly, you will have to write an insert function that appends a new property, such as "body".
6767

6868
This will have the following structure:
6969

@@ -87,29 +87,29 @@ This will have the following structure:
8787

8888
The required parameters are:
8989

90-
- `action_type` which can take values ADD or REMOVE depending on whether a customer has to be added or removed from the list.
91-
- `column_order` which can take two values, EMAIL_SHA256 and MAID_SHA256. The order indicates the column order of the data being synced inside `user_data`
92-
- `user_data` is an array of values which has hashed email id or MAID id or both. For the beta, Segment doesn’t support batching to iterate just over this array yet.
90+
- `action_type` which can take values `ADD` or `REMOVE` depending on whether a customer has to be added or removed from the list.
91+
- `column_order` which can take two values, `EMAIL_SHA256` and `MAID_SHA256`. The order indicates the column order of the data being synced inside `user_data`.
92+
- `user_data` is an array of values which has hashed `email_id` or `MAID_id` or both. While in beta, Segment doesn’t support batching to iterate just over this array yet.
9393

9494
#### Data mapping
9595

9696
In this recipe, as an example, users are added to the existing audience but you can use one or multiple mappings to perform any `PUT`, `PATCH` or `POST` action types.
9797

98-
1. Create a new mapping from the **Mappings** tab, click on **Add Mapping** and select the Send HTTP action.
98+
1. Create a new mapping from the Mappings tab, click on **Add Mapping** and select the **Send** HTTP action.
9999
2. Select events to send. Define the event triggers to send to Reddit Ads (Audiences) using the event filters.
100100
3. Fill out mapping fields:
101101
1. Specify the URL and method.
102-
- For example, using the following URL: https://ads-api.reddit.com/api/v3/custom_audiences/{audience_id}/users
103-
1. Replace `audience_id` with the actual audience ID you want to edit. You can find the iID below the name of the Audience List to be modified on Audience Manager.
104-
2. Select `PATCH` as the HTTP method. The API expects a Patch operation on the endpoint.
102+
- For example, using the following URL: `https://ads-api.reddit.com/api/v3/custom_audiences/{audience_id}/users`
103+
1. Replace `audience_id` with the actual audience ID you want to edit. You can find the ID below the name of the Audience List to be modified on Audience Manager.
104+
2. Select `PATCH` as the HTTP method. The API expects a `PATCH` operation on the endpoint.
105105
4. Use the mapping interface and search for the “body” parameter that was created in the insert function to select the transformed object that can be sent as the event body.
106106
5. Turn off batching for this operation.
107107

108-
Reddit supports three types of actions that can be performed via Extensible Webhook.
108+
Reddit supports three types of actions that can be performed via Extensible Webhooks.
109109

110110
- Audiences
111111
- Manage Audiences: Create a new audience or manage existing ones.
112-
- Manage Audience Users: PATCH users in existing audiences or create a new audience and add users to it.
112+
- Manage Audience Users: `PATCH` users in existing audiences or create a new audience and add users to it.
113113
- Campaigns
114114
- Manage Campaigns: Create a new campaign or manage existing ones.
115115

@@ -120,7 +120,8 @@ Reddit supports three types of actions that can be performed via Extensible Webh
120120

121121
Troubleshooting:
122122

123-
- If the test fails, review the authentication details and data mappings.
123+
If the test fails:
124+
- Review the authentication details and data mappings.
124125
- Check for error messages in Segment and Reddit Ads (Audiences).
125126

126127
### 7. Save and enable the destination

0 commit comments

Comments
 (0)