workflow to run stylecheck #187

bc-devrev · 2025-04-01T17:47:21Z

The stylecheck.py script sends a markdown file to Claude for revision according to defined style, structure, and terminology rules.

If a PR has the label stylecheck and not the label stylecheck-complete, the stylecheck.py script runs on any .md(x) files changed in the PR. A summary of changes is posted as a comment on the timeline. If the change is an update to an existing file, suggestions for the diff context are added. If there are any suggestions outside the diff context, the full text of the revision is included in the summary comment.

To run the script locally and not as part of a PR, use the --no-suggest flag. Also include --style=style/developer.md for developer-oriented documents.

If you want stylecheck to run on new changes on a PR where it has already run, remove the stylecheck-complete label before pushing the new changes.

github-actions · 2025-04-01T17:48:49Z

Published docs preview URL: https://devrev-preview-1671b96f-06db-409a-b4fe-741cec5ccd53.docs.buildwithfern.com

github-actions · 2025-04-01T18:14:29Z

Published docs preview URL: https://devrev-preview-c9e08cbf-c608-476b-873c-a61fa6524eb1.docs.buildwithfern.com

github-actions · 2025-04-01T18:21:20Z

Published docs preview URL: https://devrev-preview-63181aff-a617-413f-938a-7ee0fcdfa859.docs.buildwithfern.com

github-actions · 2025-04-01T18:24:37Z

Published docs preview URL: https://devrev-preview-a30d13d8-840f-4193-a38a-183c175a2b76.docs.buildwithfern.com

bc-devrev · 2025-04-01T18:26:00Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "snap-in" formatting to be consistent with hyphenation
Changed "RevOrg" instances to "workspace"

Style/Grammar fixes:

Removed unnecessary capitalization in headings and list items
Fixed parallel structure in feature list
Combined short, click-only steps in the installation instructions
Added proper sentence endings where required
Fixed inconsistent formatting and punctuation
Corrected "Updation" to "Updates" (not standard English)
Removed redundant information and made language more concise
Fixed spacing issues

bc-devrev · 2025-04-01T18:53:46Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "RevOrg" to "workspace"
Changed "snapin" to "snap-in"

Style fixes:

Corrected sentence case in headings
Added periods to list items that are complete sentences
Removed redundant periods from single-phrase items
Made list items parallel in structure
Combined some installation steps to make them more meaningful
Fixed US English spelling ("organisation" to "organization")
Made instruction steps clearer and more action-oriented
Moved conditions to the front of instruction steps where applicable
Ensured consistent technical vocabulary throughout

bc-devrev · 2025-04-01T18:53:50Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation from Datadog triggers

- Automated incident updates from Datadog changes

- Real-time synchronization between systems

- Seamless workflow integration

bc-devrev · 2025-04-01T18:53:52Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Install the snap-in

bc-devrev · 2025-04-01T18:54:47Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Standardized company name "Devrev" to "DevRev"
Changed "snap-in" formatting to use hyphen consistently
Fixed parallel structure in System Features list
Removed unnecessary end punctuation from single-phrase list items
Made installation and configuration steps more meaningful by combining related actions
Fixed capitalization in headings to use sentence case
Improved some awkward phrasing for clarity and professionalism
Standardized terminology according to the provided list
Fixed formatting inconsistencies

github-actions · 2025-04-01T18:54:47Z

Published docs preview URL: https://devrev-preview-88424c6a-231f-4bc0-8bf6-163ef3a93247.docs.buildwithfern.com

bc-devrev · 2025-04-01T18:54:51Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation: Creates corresponding incidents in DevRev when triggered in Datadog

- Automated incident updates: Reflects Datadog incident changes in DevRev

- Real-time synchronization: Ensures immediate creation and updates of incidents to reduce detection-to-resolution delays

- Seamless integration: Streamlines workflows to minimize manual intervention

bc-devrev · 2025-04-01T18:54:53Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Install the snap-in

bc-devrev · 2025-04-01T19:07:46Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "snapin" to "snap-in"
Changed "RevOrg" instances to "workspace"

Style/Grammar fixes:

Fixed capitalization in headings to sentence case
Added periods to list items that contain verbs
Improved parallel structure in feature list
Corrected some punctuation and spacing issues
Fixed "Updation" to "Update" (non-standard English word)
Removed unnecessary capitalization of common nouns
Made instruction steps more meaningful by combining related actions
Ensured consistent technical vocabulary

bc-devrev · 2025-04-01T19:07:51Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation: The snap-in creates corresponding incidents in DevRev when triggered in Datadog.

- Automated incident updates: Changes in Datadog incidents are automatically reflected in DevRev.

- Real-time synchronization: Incidents are created or updated in real-time, reducing delays between detection and resolution.

- Seamless integration: The workflow design minimizes manual intervention requirements.

bc-devrev · 2025-04-01T19:07:52Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Set up the snap-in

github-actions · 2025-04-01T19:08:31Z

Published docs preview URL: https://devrev-preview-c8202547-7ff0-4526-9a93-02a1c1b1fac9.docs.buildwithfern.com

bc-devrev · 2025-04-01T23:45:01Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation from Datadog triggers

- Automated incident updates synchronized from Datadog changes

- Real-time synchronization between platforms

- Seamless workflow integration with minimal manual intervention

bc-devrev · 2025-04-01T23:45:03Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Configure and install the snap-in

bc-devrev · 2025-04-01T23:45:09Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "RevOrg" to "workspace"
Changed "snapin" to "snap-in"

Style fixes:

Changed "Updation" (non-standard) to "Updates"
Adjusted list item punctuation according to rules
Made instruction steps more meaningful by combining related actions
Ensured parallel structure in feature list
Fixed inconsistent capitalization in headings
Removed redundant bullet points in the webhook payload section
Fixed British spelling "organisation" to American "organization"

I made suggestions where possible but couldn't add them everywhere. My complete revision is below.

Full text

# DataDog Snap-in

This integration links Datadog's monitoring system with DevRev's incident management, simplifying the process of managing workspace incidents triggered by Datadog alerts. It automatically generates new incidents and updates existing incidents in DevRev using data from Datadog, allowing your organization to address issues efficiently without manual tracking.

### System features

- Automated incident creation from Datadog triggers
- Automated incident updates synchronized from Datadog changes
- Real-time synchronization between platforms
- Seamless workflow integration with minimal manual intervention

### Configure and install the snap-in

1. In the DevRev marketplace, locate and install the DataDog snap-in for your workspace.

2. In the DevRev app, navigate to Settings > Snap-ins > Connections to set up the integration:
    1. Create a new connection or select an existing one.
    2. Select DataDog from the connection type dropdown.
    3. Enter a connection name and provide your DataDog API key, application key, and environment (prod/dev).

3. Configure the snap-in settings:
    1. Navigate to Snap-ins > All snap-ins > DataDog > Configure.
    2. Select your previously created connection.
    3. Enter the default owner, part, and severity values for incidents.
    4. Define the stage mapping between DataDog and DevRev.
    5. Save and install the configuration.

4. Set up the webhook in DataDog:
    1. Copy the webhook URL from the DevRev configuration.
    2. Add the following fields to the payload section:
        - `"aggreg_key": "$AGGREG_KEY"`
        - `"alert_metric": "$ALERT_METRIC"`
        - `"alert_query": "$ALERT_QUERY"`
    3. Complete the integration by clicking Install Integration or Update Configuration.

### References

- [DataDog DevRev snap-in marketplace listing](https://marketplace.devrev.ai/datadog-snapin)
- [DataDog DevRev snap-in documentation](https://devrev.ai/docs/integrations/datadog)
- [DataDog API](https://docs.datadoghq.com/api/latest/)

github-actions · 2025-04-01T23:45:46Z

Published docs preview URL: https://devrev-preview-128e2854-96a2-41e6-88ff-73d3fdf5ba7a.docs.buildwithfern.com

bc-devrev · 2025-04-02T00:10:53Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the provided rules. Here are the violations I fixed:

Brand name consistency: Changed "Devrev" to "DevRev" per terminology list
Term consistency: Changed "snapin" to "snap-in" per terminology list
Fixed parallel structure in System Features list - made all items start with noun phrases
Added periods to list items that contain complete sentences
Removed unnecessary capitalization in headings
Fixed some British English spellings ("organisation") to US English
Made instruction steps more meaningful by combining related actions
Improved sentence structure and clarity in several places

I made suggestions where possible but couldn't add them everywhere. My complete revision is below.

Full text

# DataDog Snap-in

This integration links Datadog's monitoring system with DevRev's incident management, simplifying the process of managing workspace incidents triggered by Datadog alerts. It automatically generates new incidents and updates existing incidents in DevRev using data from Datadog, allowing your organization to address issues efficiently without manual tracking.

### System features

- Incident creation automation: The snap-in automatically creates corresponding incidents in DevRev when triggered in Datadog.
- Incident update synchronization: All Datadog incident updates are automatically reflected in DevRev.
- Real-time processing: The snap-in processes incident creation and updates immediately to reduce delays between detection and resolution.
- Workflow integration: Built-in automation eliminates the need for manual intervention in routine tasks.

### Install the snap-in

1. Navigate to the DevRev marketplace and install the Datadog snap-in.
2. In the installation dialog, select your target workspace and click "Deploy snap-in."
3. Configure the connection settings:
    1. Navigate to Settings > Snap-ins > Connections.
    2. Create a new connection by clicking "+ Connection" or select an existing one.
    3. Select "Datadog" from the provider list and enter a connection name.
    4. Enter your Datadog API key, application key, and environment (prod/dev).

### Configure integration settings

1. Access the configuration page at Snap-ins > All snap-ins > Datadog > Configure.
2. In the Connections tab, select your previously created connection.
3. Enter the required incident settings:
    1. Specify the default owner and part.
    2. Set the default severity value.
    3. Configure the stage mapping between Datadog and DevRev.
4. Save the configuration and install the integration.
5. Set up the webhook in Datadog:
    1. Copy the provided webhook URL from DevRev.
    2. Add the following fields to the payload section:
        - `"aggreg_key": "$AGGREG_KEY"`
        - `"alert_metric": "$ALERT_METRIC"`
        - `"alert_query": "$ALERT_QUERY"`
    3. Complete the installation by clicking "Install Integration" or "Update Configuration."

### References

- [Datadog snap-in marketplace listing](https://marketplace.devrev.ai/datadog-snapin)
- [Datadog DevRev snap-in documentation](https://devrev.ai/docs/integrations/datadog)
- [Datadog API](https://docs.datadoghq.com/api/latest/)

github-actions · 2025-04-02T00:11:13Z

Published docs preview URL: https://devrev-preview-c362fc87-4aae-4c53-a81d-891ccb2e701d.docs.buildwithfern.com

bc-devrev · 2025-04-02T00:15:33Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation: The snap-in creates corresponding incidents in DevRev when triggered in Datadog.

- Automated incident updates: Changes in Datadog incidents are automatically reflected in DevRev.

- Real-time synchronization: The snap-in ensures immediate creation and updates of incidents, reducing delays between detection and resolution.

- Seamless integration: The snap-in streamlines workflows by minimizing manual intervention.

bc-devrev · 2025-04-02T00:15:35Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Install the snap-in

bc-devrev · 2025-04-02T00:15:42Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the provided style rules. Here are the violations I fixed:

Fixed company name "Devrev" to "DevRev" throughout
Changed "RevOrg" to "workspace" per terminology
Fixed "snapin" to "snap-in" per terminology
Corrected capitalization in headings to sentence case
Made list items parallel in structure
Added periods to list items that are complete sentences
Fixed spacing and formatting consistency
Removed unnecessary capitalization of "API Key," "Application Key," etc.
Made instructions more meaningful by combining related steps
Corrected "Updation" to "Updates" (non-standard English word)

I made suggestions where possible but couldn't add them everywhere. My complete revision is below.

Full text

# DataDog Snap-in

This integration links Datadog's monitoring system with DevRev's incident management, simplifying the process of managing workspace incidents triggered by Datadog alerts. It automatically generates new incidents and updates existing incidents in DevRev using data from Datadog, allowing your organization to address issues efficiently without manual tracking.

### System features

- Automated incident creation: The snap-in creates corresponding incidents in DevRev when triggered in Datadog.
- Automated incident updates: Changes in Datadog incidents are automatically reflected in DevRev.
- Real-time synchronization: The snap-in ensures immediate creation and updates of incidents, reducing delays between detection and resolution.
- Seamless integration: The snap-in streamlines workflows by minimizing manual intervention.

### Install the snap-in

1. Navigate to the DevRev marketplace and install the Datadog snap-in.
2. In the installation dialog, select your workspace and click "Deploy snap-in."
3. Configure the connection in the DevRev app:
    1. Navigate to Settings > Snap-ins > Connections.
    2. Create a new connection or select an existing one.
    3. Select Datadog from the dropdown list.
    4. Enter a connection name and provide your Datadog api key, application key, and environment (prod/dev).

### Configure the integration

1. Navigate to Snap-ins > All snap-ins > Datadog > Configure.
2. Select your previously created connection.
3. Configure the required settings:
    1. Specify the default owner, part, and severity value for incidents.
    2. Set up the stage mapping between Datadog and DevRev.
4. Save your configuration and click "Install."
5. Set up the Datadog webhook:
    1. Copy the provided webhook URL.
    2. Add the following fields to the payload section:
        1. `"aggreg_key": "$AGGREG_KEY"`
        2. `"alert_metric": "$ALERT_METRIC"`
        3. `"alert_query": "$ALERT_QUERY"`
    3. Complete the integration by clicking "Install integration" or "Update configuration."

### References

- [Datadog DevRev snap-in marketplace listing](https://marketplace.devrev.ai/datadog-snapin)
- [Datadog DevRev snap-in documentation](https://devrev.ai/docs/integrations/datadog)
- [Datadog API](https://docs.datadoghq.com/api/latest/)

github-actions · 2025-04-02T00:16:10Z

Published docs preview URL: https://devrev-preview-08bd82fb-2137-4050-a157-4f55631d9116.docs.buildwithfern.com

github-actions · 2025-04-02T13:59:09Z

Published docs preview URL: https://devrev-preview-ab7ae21c-9d3b-4d36-8a38-256acc2a4aec.docs.buildwithfern.com

…api-docs into bc/check-ISS-157878

github-actions · 2025-04-02T16:44:12Z

Published docs preview URL: https://devrev-preview-c26f0622-d846-4ba0-af8a-25295a38c81d.docs.buildwithfern.com

bc-devrev · 2025-04-02T16:50:09Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Automated incident creation: The snap-in creates corresponding incidents in DevRev when triggered in Datadog.

- Automated incident updates: Changes in Datadog incidents are automatically reflected in DevRev.

- Real-time synchronization: The snap-in ensures immediate creation and updates of incidents, reducing delays between detection and resolution.

- Seamless integration: Built-in workflow optimization minimizes manual intervention requirements.

bc-devrev · 2025-04-02T16:50:11Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Install the snap-in

bc-devrev · 2025-04-02T16:50:17Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "RevOrg" to "workspace"
Changed "snapin" to "snap-in"

Style fixes:

Corrected sentence case in headings
Made list items parallel in structure
Added proper punctuation to list items
Removed unnecessary capitalization (e.g., "API Key" to "API key")
Fixed inconsistent spelling ("Updation" is not standard English)
Made instruction steps more meaningful by combining related actions

I made suggestions where possible but couldn't add them everywhere. My complete revision is below.

Full text

# DataDog Snap-in

This integration links Datadog's monitoring system with DevRev's incident management, simplifying the process of managing workspace incidents triggered by Datadog alerts. It automatically generates new incidents and updates existing incidents in DevRev using data from Datadog, allowing your organization to address issues efficiently without manual tracking.

### System features

- Automated incident creation: The snap-in creates corresponding incidents in DevRev when triggered in Datadog.
- Automated incident updates: Changes in Datadog incidents are automatically reflected in DevRev.
- Real-time synchronization: The snap-in ensures immediate creation and updates of incidents, reducing delays between detection and resolution.
- Seamless integration: Built-in workflow optimization minimizes manual intervention requirements.

### Install the snap-in

1. Navigate to the DevRev marketplace and install the Datadog snap-in.
2. Select your target workspace and deploy the snap-in.
3. In the DevRev application, configure the connection by navigating to Settings > Snap-ins > Connections.
    1. Create a new connection or select an existing one.
    2. Select Datadog from the available options.
    3. Enter a connection name and provide your Datadog API key, application key, and environment (prod/dev).

### Configure the integration

1. Navigate to Snap-ins > All snap-ins > Datadog > Configure.
2. Select your previously created connection.
3. Enter the required default values for incident owner, part, and severity.
4. Configure the stage mapping between Datadog and DevRev.
5. Save your configuration and click Install.
6. Copy the webhook URL and configure it in Datadog with the following payload elements:
    1. Add `"aggreg_key": "$AGGREG_KEY"`
    2. Add `"alert_metric": "$ALERT_METRIC"`
    3. Add `"alert_query": "$ALERT_QUERY"`
    4. Complete the integration by clicking Install integration or Update configuration.

### References

- [Datadog DevRev snap-in marketplace listing](https://marketplace.devrev.ai/datadog-snapin)
- [Datadog DevRev snap-in documentation](https://devrev.ai/docs/integrations/datadog)
- [Datadog API](https://docs.datadoghq.com/api/latest/)

github-actions · 2025-04-02T16:50:46Z

Published docs preview URL: https://devrev-preview-b966b304-b482-4f9e-8b0b-4df49ab00e31.docs.buildwithfern.com

bc-devrev · 2025-04-02T16:51:20Z

style/sample-common.mdx

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.


Suggested change

- Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.

- Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.

- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.

- Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

- Creates incidents in DevRev automatically when triggered in DataDog.

- Updates incident details in DevRev when changes occur in DataDog.

- Synchronizes incident data in real-time between systems.

- Streamlines workflows by minimizing manual intervention.

bc-devrev · 2025-04-02T16:51:22Z

style/sample-common.mdx

@@ -6,7 +6,7 @@ This integration links Datadog's monitoring system with Devrev's incident manage

 - Automated Incident Creation: When an incident is triggered in Datadog, the snap-in automatically creates a corresponding incident in DevRev.
 - Automated Incident Updation: When an incident is updated in Datadog, the changes are reflected in DevRev.
- Real-Time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
+- Real-time Synchronization: The snap-in ensures that incidents are created or updated in real-time, reducing delays between detection and resolution. DevRev captures the necessary incident details from the Datadog payload, allowing teams to address and mitigate issues.
 - Seamless integration: The snap-in is built to streamline workflows, minimizing the need for manual intervention.

 ### Installing the Snap-in


Suggested change

### Installing the Snap-in

### Install the snap-in

bc-devrev · 2025-04-02T16:51:29Z

✨ Comment from AI reviewer ✨

I'll analyze the document and make necessary revisions according to the style rules. Here are the violations I fixed:

Terminology fixes:

Changed "Devrev" to "DevRev"
Changed "RevOrg" to "workspace"
Changed "snapin" to "snap-in"

Style/grammar fixes:

Fixed capitalization in headings to sentence case
Ensured parallel structure in lists
Combined some installation steps to make them more meaningful
Added proper punctuation to list items
Fixed some British English spellings ("organisation") to American English
Removed redundant sentences and made language more concise
Fixed inconsistent terminology usage

I made suggestions where possible but couldn't add them everywhere. My complete revision is below.

Full text

# DataDog Snap-in

This integration links DataDog's monitoring system with DevRev's incident management, simplifying the process of managing workspace incidents triggered by DataDog alerts. It automatically generates new incidents and updates existing incidents in DevRev using data from DataDog, allowing your organization to address issues efficiently without manual tracking.

### System features

- Creates incidents in DevRev automatically when triggered in DataDog.
- Updates incident details in DevRev when changes occur in DataDog.
- Synchronizes incident data in real-time between systems.
- Streamlines workflows by minimizing manual intervention.

### Install the snap-in

1. Navigate to the DevRev marketplace and install the DataDog snap-in.
2. Select your target workspace and deploy the snap-in.
3. In the DevRev app, configure the connection under Settings > Snap-ins > Connections:
    1. Search for an existing connection or create a new one.
    2. Select DataDog from the connection type dropdown.
    3. Enter a connection name and provide your DataDog API key, application key, and environment (prod/dev).

### Configure the integration

1. Navigate to Snap-ins > All snap-ins > DataDog > Configure.
2. Select your previously created connection.
3. Configure the required settings:
    1. Set the default owner, part, and severity value for incidents.
    2. Map the stages between DataDog and DevRev.
4. Save your configuration and install the integration.
5. Set up the webhook in DataDog:
    1. Copy the webhook URL from DevRev.
    2. Add the following fields to the payload section:
        - `"aggreg_key": "$AGGREG_KEY"`
        - `"alert_metric": "$ALERT_METRIC"`
        - `"alert_query": "$ALERT_QUERY"`
    3. Complete the integration installation or update the configuration.

### References

- [DataDog DevRev snap-in marketplace listing](https://marketplace.devrev.ai/datadog-snapin)
- [DataDog DevRev snap-in documentation](https://devrev.ai/docs/integrations/datadog)
- [DataDog API](https://docs.datadoghq.com/api/latest/)

workflow to run stylecheck

050a8a4

bc-devrev added the stylecheck Revise markdown files according to DevRev style guidelines label Apr 1, 2025

change to trigger check

0f55fe5

temp files

a0fe547

secret for LLM

c9f7e11

bc-devrev added 2 commits April 1, 2025 11:40

fix archive name

4efaf11

include commit ID

9f8b4b8

bc-devrev commented Apr 1, 2025

View reviewed changes

bc-devrev added the No EkLine Skip EkLine automated QA label Apr 1, 2025

bc-devrev commented Apr 1, 2025

View reviewed changes

fix date format again

48e6a40

bc-devrev commented Apr 1, 2025

View reviewed changes

post full text of revision where suggestions are outside the PR diff

5cf1330

bc-devrev commented Apr 1, 2025

View reviewed changes

fixed success criteria

f04e836

bc-devrev commented Apr 2, 2025

View reviewed changes

github-actions bot added the stylecheck-complete label Apr 2, 2025

bc-devrev marked this pull request as ready for review April 2, 2025 13:57

bc-devrev requested a review from a team as a code owner April 2, 2025 13:57

Merge branch 'main' into bc/check-ISS-157878

e18e368

Atul-Butola approved these changes Apr 2, 2025

View reviewed changes

bc-devrev added 2 commits April 2, 2025 09:42

include developer style rules

ea86f80

Merge branch 'bc/check-ISS-157878' of https://github.com/devrev/fern-…

5c7a949

…api-docs into bc/check-ISS-157878

bc-devrev removed the stylecheck-complete label Apr 2, 2025

run if label removed

c6e26e4

bc-devrev commented Apr 2, 2025

View reviewed changes

github-actions bot added the stylecheck-complete label Apr 2, 2025

bc-devrev removed the stylecheck-complete label Apr 2, 2025

bc-devrev commented Apr 2, 2025

View reviewed changes

github-actions bot added the stylecheck-complete label Apr 2, 2025

bc-devrev merged commit 4325cc4 into main Apr 2, 2025
5 checks passed

bc-devrev deleted the bc/check-ISS-157878 branch April 2, 2025 16:59

	### Installing the Snap-in
	### Configure and install the snap-in

workflow to run stylecheck #187

workflow to run stylecheck #187

Uh oh!

Conversation

bc-devrev commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

bc-devrev commented Apr 1, 2025

Uh oh!

bc-devrev commented Apr 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 1, 2025

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

bc-devrev commented Apr 2, 2025

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 2, 2025

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 2, 2025

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bc-devrev commented Apr 2, 2025

Uh oh!

Uh oh!

Uh oh!

bc-devrev commented Apr 1, 2025 •

edited

Loading