Skip to content

Commit ab29361

Browse files
Port in-product tile instructions for some OAuth integrations to the README that gets parsed inside the "Configuration instructions" section (DataDog#23673)
* Port in-product tile instructions for some OAuth integrations to the README that gets parsed inside the "Configuration instructions" section * Fix URL reference index * Apply all suggestions from code review, thank you! Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Fix incorrect link --------- Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
1 parent b477b35 commit ab29361

4 files changed

Lines changed: 62 additions & 151 deletions

File tree

docusign/README.md

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,13 @@ Docusign integration provides real-time insights into Docusign activities, such
88

99
## Setup
1010

11+
To collect Docusign logs, click **Authorize** to authenticate using OAuth.
1112

12-
### Prerequisites
13-
14-
- Docusign Developer Account
15-
- Docusign account with a plan that includes Docusign Monitor
16-
17-
18-
### Generate API credentials in Docusign
19-
20-
1. Log in to [Developer Admin Console][2].
21-
2. Get your **Account Name** from the **Account Profile** page.
22-
3. Access the **Apps and Keys** page under the **Integrations** section.
23-
4. Obtain the **User ID** from the **My Account Information** section.
24-
5. Click on **Add App and Integration Key** button.
25-
6. Provide an App Name and click **Create App**.
26-
7. Get your **Integration Key** from the General Info section.
27-
8. Click on **Generate RSA**, to get **RSA Private Key**.
28-
9. Click on **ADD URI**, set Redirect URI to `http://localhost/`.
29-
10. Click on **Save** button.
30-
11. Perform application consent by opening the accompanying Sample URL after replacing the placeholders
31-
- URL: `<BASE_URI>/oauth/auth?response_type=code&scope=signature impersonation organization_read&client_id=<YOUR_INTEGRATION_KEY>&redirect_uri=<YOUR_REDIRECT_URI>`
32-
- `<BASE_URI>`: Use `https://account-d.docusign.com` for Developer or `https://account.docusign.com` for Production.
33-
- `<YOUR_INTEGRATION_KEY>`: Replace with your Integration Key (Client ID) obtained previously.
34-
- `<YOUR_REDIRECT_URI>`: Replace with your redirect URI, e.g., `http://localhost/`.
35-
- Sign in to your account if prompted to
36-
- Click on **Allow Access**
37-
- Note: _After selecting Accept, the browser will display a message saying that it can't load the page. You can safely ignore this page and close the tab._
38-
12. To test the integration with Developer account, select `Developer` option for the **Account Type** configuration parameter of the integration.
39-
13. Perform the [Go-Live][3] process for the App to access the [Production Account][4].
40-
14. Navigate to the Admin console and perform steps 2 to 10 and update the respective configuration parameters for the integration.
41-
42-
43-
### Connect your Docusign Account to Datadog
44-
45-
1. Add your Account Type, Docusign Account Name, User Id, Integration Key, and RSA Private Key
46-
|Parameters|Description|
47-
|--------------------|--------------------|
48-
|Account Type|Dropdown to select the type of Docusign account (e.g., Developer or Production).|
49-
|Docusign Account Name|The name associated with the Docusign account (case sensitive).|
50-
|User ID |A GUID value that uniquely identifies a Docusign user.|
51-
|Integration Key|A unique GUID that identifies a Docusign integration.|
52-
|RSA Private Key|A cryptographic key for signing JWT tokens for secure API authentication.|
53-
2. Click the Save button to save your settings.
13+
To add a Docusign account, make sure that:
14+
15+
- The account has **admin access permission** within your Docusign organization. Otherwise, Datadog can't collect log events for you.
16+
- The account is **not an admin** of more than one Docusign organization, as explained in [How to get monitoring data][2].
17+
- The **Docusign Monitor** feature is enabled. This integration is only available for accounts with the paid version of [Monitor][3].
5418

5519
## Data Collected
5620

@@ -68,10 +32,9 @@ The Docusign integration does not include any events.
6832

6933
## Support
7034

71-
For further assistance, contact [Datadog Support][5].
35+
For further assistance, contact [Datadog Support][4].
7236

7337
[1]: https://www.docusign.com/
74-
[2]: https://apps-d.docusign.com/admin/admin-dashboard
75-
[3]: https://developers.docusign.com/platform/go-live/
76-
[4]: https://apps.docusign.com/admin/admin-dashboard
77-
[5]: https://docs.datadoghq.com/help/
38+
[2]: https://developers.docusign.com/docs/monitor-api/how-to/get-monitoring-data/
39+
[3]: https://www.docusign.com/products/monitor
40+
[4]: https://docs.datadoghq.com/help/

hubspot_content_hub/README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,36 @@
66

77
The HubSpot Content Hub integration collects Activity Logs (audit, login, security) and Analytics Metrics (breakdown categories, content types), sending them to Datadog for detailed analysis. The logs are parsed and enriched for efficient searching, while the metrics provide insights into content performance.
88

9-
Use Datadog [Reference Tables][5] to enrich your telemetry with metadata from HubSpot. You can map value fields to a primary key to automatically append these fields to logs or events containing that key.
9+
Use Datadog [Reference Tables][2] to enrich your telemetry with metadata from HubSpot. You can map value fields to a primary key to automatically append these fields to logs or events containing that key.
1010

1111
The integration includes dashboards that show and analyze both Activity Logs and Analytics Metrics, making it easier to monitor and understand trends and issues.
1212

1313
## Setup
1414

15-
To integrate HubSpot with Datadog, Datadog connects to HubSpot using OAuth. The authenticated user must have owner permissions in the organizations that want to be integrated.
15+
To integrate HubSpot with Datadog, you must authenticate as an owner of the HubSpot organization that Datadog fetches data from.
1616

17-
### Installation
17+
### Metrics and Logs
1818

19-
1. Navigate to the [Integrations Page][2] and search for the "HubSpot Content Hub" integration.
20-
2. Click the tile.
21-
3. To add an account to install the integration, click the **Add Account** button.
22-
4. Read the instructions in the modal and choose your telemetry and reference tables settings. Then, click the **Authorize** button, which redirects you to the HubSpot login page.
23-
5. After logging in, you are prompted to select which HubSpot account you want to grant access to.
24-
6. Click **Authorize**.
25-
7. You're redirected back to Datadog's HubSpot tile with a new account. Datadog recommends changing the account name to something that is easier to remember. You can add multiple accounts with access to different organizations.
19+
To collect HubSpot metrics and logs, click the **Authorize** button to authenticate using OAuth.
2620

27-
**Note**: HubSpot saves this authorization selection. To be prompted again or add new organizations, revoke app access in HubSpot (`User Preferences > Integrations > Connected Applications > Datadog - HubSpot OAuth App`), then restart the setup process.
21+
### Companies Reference Tables
22+
23+
Import company data from HubSpot as a Reference Table to enrich your Datadog logs and metrics with CRM details. You can also join Reference Tables with Product Analytics to correlate activity data across accounts.
24+
25+
#### Get Started
26+
27+
- Enable **Companies Reference Table** and click the **Authorize** button.
28+
29+
#### After Setup
30+
31+
- Datadog automatically creates one Companies Reference Table for each account, using the format `hubspot_companies_hubspotaccountid`.
32+
- Your [HubSpot Reference Tables][3] are available after a few minutes. Datadog automatically starts syncing data after the table is created.
33+
- Use [Event Management][4] to monitor your Reference Table's creation. You'll see progress events, success confirmations, and any errors that occur.
34+
- When ingestion succeeds, a [success event][5] appears for your Reference Table.
35+
36+
#### For Existing Accounts
37+
38+
- To create a Company Reference Table for an existing HubSpot account, edit the account and select the Companies Reference Table toggle.
2839

2940
## Data Collected
3041

@@ -48,14 +59,15 @@ The HubSpot Content Hub integration does not include any events.
4859

4960
### Reference Tables
5061

51-
[Reference Tables][5] allow you to automatically enrich and join your telemetry with additional fields from Companies defined in your HubSpot account.
62+
[Reference Tables][2] allow you to automatically enrich and join your telemetry with additional fields from Companies defined in your HubSpot account.
5263

5364
## Troubleshooting
5465

55-
Need help? Contact [Datadog support][3].
66+
Need help? Contact [Datadog support][6].
5667

5768
[1]: https://www.hubspot.com/products/content
58-
[2]: /integrations
59-
[3]: https://app.hubspot.com/login
60-
[4]: https://docs.datadoghq.com/help/
61-
[5]: /reference-tables
69+
[2]: /reference-tables
70+
[3]: /reference-tables?order=desc&p=1&sort=updated_at&source=HUBSPOT_CONTENT_HUB
71+
[4]: /event/explorer?query=source%3Ahubspot_content_hub&from_ts=1767286800000&to_ts=1767294000000&live=true
72+
[5]: /event/explorer?query=source%3Ahubspot_content_hub%20status%3Aok&from_ts=1767286800000&to_ts=1767294000000&live=true
73+
[6]: https://docs.datadoghq.com/help/

klaviyo/README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,16 @@ Integrate Klaviyo with Datadog to gain insights into marketing campaign communic
88

99
## Setup
1010

11-
Follow the instructions below to configure this integration for Klaviyo Marketing and eCommerce events.
11+
To authenticate this integration, you must have access to the following Klaviyo Scopes:
1212

13-
### Configuration
13+
- `accounts:read`
14+
- `events:read`
15+
- `flows:read`
16+
- `metrics:read`
1417

15-
#### Install Datadog Integration in Klaviyo
16-
Within your Klaviyo account, first add the Datadog integration. The integration allows Datadog
17-
to see Klaviyo events and metrics via the Klaviyo API.
18+
To add a Klaviyo account, click **Authorize** and follow the instructions. After you are redirected back to this page and authentication succeeds, your logs should be available within 5 minutes.
1819

19-
1. Log in to your [Klaviyo account][2].
20-
2. In the left-side panel, navigate to **Integrations**.
21-
3. Click **Add integrations**.
22-
4. Search for Datadog and click on the tile.
23-
5. Click **Install**.
24-
6. Navigate to Datadog, then log in.
25-
26-
#### Install Klaviyo Integration in Datadog
27-
After the above installation within Klaviyo is performed, complete the Datadog integration by clicking
28-
**Install Integration** which guides you through an authorization process with Klaviyo.
29-
30-
The authorization process will include an approval dialog which asks to give Datadog permission to
31-
read Klaviyo events and metrics. The scopes involved for this
32-
access are "accounts:read metrics:read events:read" and nothing more.
20+
You can view your logs in the [Log Explorer][2]. Ensure you have a [Logs Index][3] set up for `source:klaviyo`.
3321

3422
## Data Collected
3523

@@ -50,9 +38,10 @@ Klaviyo does not include any events.
5038

5139
## Troubleshooting
5240

53-
Need help? Contact [Datadog support][3].
41+
Need help? Contact [Datadog support][4].
5442

5543
[1]: https://www.klaviyo.com/
56-
[2]: https://www.klaviyo.com/login
57-
[3]: https://docs.datadoghq.com/help/
44+
[2]: /logs?query=source%3Aklaviyo%2A
45+
[3]: /logs/pipelines/indexes
46+
[4]: https://docs.datadoghq.com/help/
5847

ringcentral/README.md

Lines changed: 12 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -2,69 +2,20 @@
22

33
## Overview
44

5-
[RingCentral][5] is a leading cloud-based communication and collaboration platform for businesses. It offers services such as voice, messaging, and video conferencing, seamlessly integrating with various business applications.
5+
[RingCentral][1] is a leading cloud-based communication and collaboration platform for businesses. It offers services such as voice, messaging, and video conferencing, seamlessly integrating with various business applications.
66

77
The RingCentral integration collects voice and audit logs, as well as Voice (Analytics) and A2P SMS metrics, and sends them to Datadog for comprehensive analysis.
88

99
## Setup
1010

11-
### Generate API Credentials in RingCentral
12-
13-
1. Log into your [RingCentral Developer][2] account using a user with a Super Admin role or [Custom role](#create-and-assign-a-custom-role).
14-
2. Click **Console**.
15-
3. Under the *Apps* section, click **Register App**.
16-
4. Select **Rest API app** for the App type .
17-
5. Fill in the required details for your application, such as the name and description.
18-
19-
| Field | Selection |
20-
| --- | ----------- |
21-
| Do you intend to promote this app in the RingCentral App Gallery? | **No** |
22-
| Auth type | **JWT auth flow** |
23-
| Issue refresh tokens | **Yes** |
24-
| Application scopes | Select the following: Analytics, Read Audit Trail, Read Call Log, A2P SMS|
25-
6. Click on Create App.
26-
7. After creating the application, find the `clientId` and `clientSecret` in the application settings.
27-
8. To get the JWT Token, locate the **Credentials** by clicking your username in the top-right corner.
28-
9. Click **Create JWT**.
29-
10. Add an appropriate label and select the **Production** environment.
30-
11. Allow this JWT token for only a specific app and add the `clientId` of the application created above.
31-
12. If you select an expiration date, make sure you create a new JWT and update it in the integration configuration before the expiry date.
32-
13. Click **Create JWT**.
33-
34-
35-
#### Create and assign a custom role
36-
1. Create a custom role, following the [RingCentral documentation][3].
37-
2. Select **Standard** role as a starting point.
38-
3. Provide additional **Audit Trail** and **Company Call Log - View Only** permissions to the role.
39-
4. Assign a custom role to a user, following the [RingCentral documentation][4].
40-
41-
42-
### Get RingCentral account ID
43-
1. Visit [RingCentral][1] and log in as a Super Admin.
44-
2. Under the **Users** section, click **Users with Extensions**.
45-
3. From the list of users, click on the user who has a "Super Admin" suffix in their name to open the user's details panel.
46-
4. Look at the URL in your web browser's address bar.
47-
5. Find the 9-digit number within the URL. This is your RingCentral account ID.
48-
- **Example URL:** https://service.ringcentral.com/application/users/users/default/123456789/settings/default
49-
- The `123456789` is your Account ID.
50-
51-
52-
### Connect your RingCentral account to Datadog
53-
54-
1. Add your RingCentral credentials.
55-
56-
| Parameters | Description |
57-
| --------------- | --------------------------------------------------------------|
58-
|Account ID | The account ID of RingCentral. |
59-
|Client ID | The client ID of the RingCentral application. |
60-
|Client Secret | The client secret of the RingCentral application. |
61-
|JWT Token | The JWT token from RingCentral. |
62-
|Get Voice Calls Logs | Enable to collect voice call logs from RingCentral. The default value is "true". |
63-
|Get Voice(Analytics) Metrics | Enable to collect Voice(Analytics) metrics from RingCentral. The default value is "true". |
64-
|Get SMS Metrics | Enable to collect SMS metrics from RingCentral. The default value is "true". |
65-
|Get Audit Logs | Enable to collect audit logs from RingCentral. The default value is "true". |
66-
67-
2. Click the **Save** button to save your settings.
11+
To collect RingCentral logs and metrics, click the **Authorize** button to authenticate using OAuth.
12+
13+
To integrate RingCentral with Datadog, you need a RingCentral account with appropriate permissions to access the RingCentral APIs. The required permissions are:
14+
15+
- Read Call Log
16+
- Read Audit Trail
17+
- Analytics
18+
- A2P SMS
6819

6920
## Data Collected
7021

@@ -84,11 +35,7 @@ The RingCentral integration does not include any events.
8435

8536
## Support
8637

87-
For further assistance, contact [Datadog Support][6].
38+
For further assistance, contact [Datadog Support][2].
8839

89-
[1]: https://service.ringcentral.com/
90-
[2]: https://developers.ringcentral.com/
91-
[3]: https://support.ringcentral.com/article-v2/10641-user-roles-permissions-edit-permission-custom-role.html?brand=RC_US&product=RingEX&language=en_US
92-
[4]: https://support.ringcentral.com/article-v2/10647-user-roles-permissions-assign-role-user-details.html?brand=RC_US&product=RingEX&language=en_US
93-
[5]: https://www.ringcentral.com/
94-
[6]: https://docs.datadoghq.com/help/
40+
[1]: https://www.ringcentral.com/
41+
[2]: https://docs.datadoghq.com/help/

0 commit comments

Comments
 (0)