Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SIEMINT-122] DDSaaS: Brevo: Integration v1.0.0 #18564

Merged
merged 56 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
fb51475
brevo integration project skeleton
bparmar-crest Aug 29, 2024
cd73f7f
Merge branch 'DataDog:master' into brevo-assets-v1.0.0
bparmar-crest Aug 29, 2024
9229051
brevo.svg added
bparmar-crest Aug 29, 2024
5b3ad32
added all assets and modified readme, manifest files
rajshah-crest Sep 10, 2024
2e36e07
added more samples
rajshah-crest Sep 10, 2024
6fa35fa
minor correction in sample
rajshah-crest Sep 10, 2024
1361478
Merge branch 'DataDog:master' into brevo-assets-v1.0.0
bparmar-crest Sep 11, 2024
9f31c1f
changed dashboards, corrections in readme,manifest
rajshah-crest Sep 11, 2024
7733daf
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 11, 2024
d926e3f
to resolve failed checks
rajshah-crest Sep 11, 2024
d8b11ba
dashboard and pipeline changes
rajshah-crest Sep 11, 2024
bbf499f
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Sep 11, 2024
d9cbede
minor corrections
rajshah-crest Sep 11, 2024
0632113
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 11, 2024
d5fe343
fixing pipeline failure
rajshah-crest Sep 11, 2024
cf5d58e
fixing pipeline failure
rajshah-crest Sep 11, 2024
b1ae3c2
fixing pipeline failure
rajshah-crest Sep 11, 2024
cb5b27b
conflicts resolved
bparmar-crest Sep 12, 2024
f8b37a8
Updated Dashboard and Pipeline
rajshah-crest Sep 12, 2024
24c6b36
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 12, 2024
39cb322
fixing pipeline failure
rajshah-crest Sep 12, 2024
e4250e6
minor corrections in dashboard and pipeline
rajshah-crest Sep 13, 2024
8199b51
minor dashbaord changes
rajshah-crest Sep 13, 2024
da2a4dd
minor dashbaord change
rajshah-crest Sep 13, 2024
8fc3635
Update README and monitor descriptions
rajshah-crest Sep 17, 2024
e4654ae
Merge branch 'master' into brevo-assets-v1.0.0
rajshah-crest Sep 17, 2024
23b52c6
Fix character limit issue in monitor descriptions
rajshah-crest Sep 17, 2024
d9af73c
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 17, 2024
2b29b3c
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Sep 17, 2024
e7a62ad
minor change in dashboards
rajshah-crest Sep 17, 2024
73187dd
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 17, 2024
f4f5580
change in dashboard and pipeline
rajshah-crest Sep 18, 2024
51d7316
fix pipeline failure
rajshah-crest Sep 18, 2024
631d30c
change in dashboard
rajshah-crest Sep 18, 2024
6e5d5ae
changed image and modified monitor content
rajshah-crest Sep 18, 2024
04d838d
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Sep 24, 2024
eabc8dd
Updated monitor description and title
rajshah-crest Sep 24, 2024
57ab5f4
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Sep 24, 2024
92335ff
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Sep 27, 2024
f85c20a
whitespace omitted
bparmar-crest Sep 27, 2024
77788b9
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Oct 3, 2024
d3950ea
Modified sample logs for transactional events
rajshah-crest Oct 3, 2024
7ee7d5f
Merge branch 'brevo-assets-v1.0.0' of github.com:bhargavnariyanicrest…
rajshah-crest Oct 3, 2024
c82b758
Fix log samples failure
rajshah-crest Oct 3, 2024
a44daeb
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Nov 7, 2024
0d72beb
CODEOWNERS
bparmar-crest Nov 7, 2024
09633c1
Integration name removed from monitors
bparmar-crest Nov 7, 2024
4740772
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Nov 11, 2024
d0c3568
review comments incorporated
bparmar-crest Nov 11, 2024
c15dd5f
Merge branch 'master' into brevo-assets-v1.0.0
apiazza-dd Nov 21, 2024
4ef71ba
Merge branch 'master' into brevo-assets-v1.0.0
apiazza-dd Dec 11, 2024
e6b5409
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Dec 12, 2024
5eedb5b
Merge branch 'master' into brevo-assets-v1.0.0
bparmar-crest Dec 16, 2024
3db943a
README.md modified
bparmar-crest Dec 16, 2024
72d7954
conflicts resolved
bparmar-crest Dec 17, 2024
4272678
Merge branch 'master' into brevo-assets-v1.0.0
apiazza-dd Dec 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,11 @@ datadog_checks_base/datadog_checks/base/checks/windows/ @DataDog/wi
/authorize_net/metadata.csv @DataDog/saas-integrations @DataDog/documentation
/authorize_net/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/brevo/ @DataDog/saas-integrations
/brevo/*.md @DataDog/saas-integrations @DataDog/documentation
/brevo/manifest.json @DataDog/saas-integrations @DataDog/documentation
/brevo/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/cisco_umbrella_dns/ @DataDog/saas-integrations
/cisco_umbrella_dns/*.md @DataDog/saas-integrations @DataDog/documentation
/cisco_umbrella_dns/manifest.json @DataDog/saas-integrations @DataDog/documentation
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ integration/azure_iot_edge:
- azure_iot_edge/**/*
integration/boundary:
- boundary/**/*
integration/brevo:
- brevo/**/*
integration/btrfs:
- btrfs/**/*
integration/cacti:
Expand Down
7 changes: 7 additions & 0 deletions brevo/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - Brevo

## 1.0.0 / 2024-08-27

***Added***:

* Initial Release
64 changes: 64 additions & 0 deletions brevo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Brevo

## Overview

[Brevo][1] is a cloud-based digital marketing platform designed for creating, sending, and tracking email campaigns, transactional emails, and more. It offers tools for automation and analytics, helping businesses optimize their email marketing strategies and monitor performance.

Integrate Brevo with Datadog to gain insights into Brevo marketing campaign emails and track Brevo performance based on events and other transactional events using [webhooks][2].

## Setup

Follow the instructions below to configure this integration for Brevo Marketing and Transactional events through a Webhook.

### Configuration

#### Webhook configuration for marketing events
Configure the Datadog endpoint to forward Brevo marketing events as logs to Datadog. For more details, see the Brevo [Marketing webhooks][3] documentation.
apiazza-dd marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

@apiazza-dd apiazza-dd Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are the instructions I'm putting on the tile, can you please update them to match:

### Webhook Configuration for Brevo Marketing Events

Configure the Datadog endpoint to forward Brevo marketing events as logs to Datadog. For more information, see Brevo's [How To Use Webhooks](https://developers.brevo.com/docs/how-to-use-webhooks) documentation.

1. Either select an existing API key or create a new API key by clicking one of the buttons below. Clicking either button will generate a URL for further action.
2. Log in to your [Brevo account](https://login.brevo.com/).
3. In the left navigation panel, click **Campaigns**.
4. Open the **Settings** page.
5. In the **Webhooks** section, click **Configure**.
6. Click **Add a New Webhook**.
7. Enter the previously identified webhook URL.
8. Select the types of messages and contact logs to forward to Datadog.
9. Click **Add** to save.

### Webhook Configuration for Brevo Transactional Events

Set up the Datadog endpoint to forward Brevo transactional events as logs to Datadog. For more details, refer to the Brevo [Transactional Webhooks](https://developers.brevo.com/docs/transactional-webhooks) documentation.

1. Select an existing API key or create a new one by clicking one of the buttons below.
2. Log in to your [Brevo account](https://login.brevo.com/). (If already logged in, you'll be redirected to the [Brevo homepage](https://app.brevo.com/).)
3. In the left navigation panel, click **Transactional**.
4. Open the **Settings** and select **Webhook**.
5. Click **Add a New Webhook**.
6. Enter the previously identified webhook URL.
7. Choose the types of message logs to forward to Datadog.
8. Click **Save** to finalize the setup.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to merge this as is and then make the changes myself so I don't block you from testing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@apiazza-dd I think the links which is mentioned in configuration steps of Marketing events should point to marketing webhook settings page instead of how to use webhook page.
Below is the revised content of what you shared. Please review and let us know in case of any changes.
Also, the links which are mentioned as [3], [4] is defined at the end of the README file. Hence it points to correct destination.

### Webhook Configuration for Brevo Marketing Events

Configure the Datadog endpoint to forward Brevo marketing events as logs to Datadog. For more information, see Brevo's [Marketing Webhooks][3] documentation.

1. Either select an existing API key or create a new API key by clicking one of the buttons below. Clicking either button will generate a URL for further action.
2. Log in to your [Brevo account][4].
3. In the left navigation panel, click **Campaigns**.
4. Open the **Settings** page.
5. In the **Webhooks** section, click **Configure**.
6. Click **Add a New Webhook**.
7. Enter the previously identified webhook URL.
8. Select the types of messages and contact logs to forward to Datadog.
9. Click **Add** to save.

### Webhook Configuration for Brevo Transactional Events

Set up the Datadog endpoint to forward Brevo transactional events as logs to Datadog. For more details, refer to the Brevo [Transactional Webhooks][5] documentation.

1. Select an existing API key or create a new one by clicking one of the buttons below.
2. Log in to your [Brevo account][4]. (If already logged in, you'll be redirected to the [Brevo homepage][6].)
3. In the left navigation panel, click **Transactional**.
4. Open the **Settings** and select **Webhook**.
5. Click **Add a New Webhook**.
6. Enter the previously identified webhook URL.
7. Choose the types of message logs to forward to Datadog.
8. Click **Save** to finalize the setup.


## Data Collected

### Logs
The Brevo integration forwards the marketing and transactional event logs to Datadog.

### Metrics
Brevo does not include any metrics.

### Service Checks
Brevo does not include any service checks.

### Events
Brevo does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][7].

[1]: https://www.brevo.com/products/marketing-platform/
[2]: https://developers.brevo.com/docs/how-to-use-webhooks
[3]: https://developers.brevo.com/docs/marketing-webhooks
[4]: https://login.brevo.com/
[5]: https://developers.brevo.com/docs/transactional-webhooks
[6]: https://app.brevo.com/
[7]: https://docs.datadoghq.com/help/


1. Select an existing API key or create a new one by clicking one of the buttons below:
2. Log in to your [Brevo account][4].
3. In the left-side panel, navigate to **Campaigns**.
4. Navigate to the **Settings** Page.
5. Under the **Webhooks** section, click **Configure**.
6. Click **Add a New Webhook**.
7. Enter the webhook URL that you identified previously.
8. Choose the types of messages and contact logs you want to forward to Datadog.
9. Click **Add**.

#### Webhook configuration for transactional events
Configure the Datadog endpoint to forward Brevo transactional events as logs to Datadog. For more details, see the Brevo [Transactional webhooks][5] documentation.

1. Select an existing API key or create a new one by clicking one of the buttons below:
2. Log in to your [Brevo account][4]. If you are already logged in, Brevo automatically redirects to the [Brevo homepage][6].
3. In the left-side panel, navigate to **Transactional**.
4. In **Settings**, click "**Webhook**".
5. Click **Add a new webhook**.
6. Enter the webhook URL that you identified previously.
7. Select the types of message logs to forward to Datadog.
8. Click **Save**.

## Data Collected

### Logs
The Brevo integration forwards the marketing and transactional event logs to Datadog.

### Metrics
Brevo does not include any metrics.

### Service Checks
Brevo does not include any service checks.

### Events
Brevo does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][7].

[1]: https://www.brevo.com/products/marketing-platform/
[2]: https://developers.brevo.com/docs/how-to-use-webhooks
[3]: https://developers.brevo.com/docs/marketing-webhooks
[4]: https://login.brevo.com/
[5]: https://developers.brevo.com/docs/transactional-webhooks
[6]: https://app.brevo.com/
[7]: https://docs.datadoghq.com/help/
3 changes: 3 additions & 0 deletions brevo/assets/brevo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading