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

[INTPLAT-457] DDSaaS: Postmark: Integration v1.0.0 #18898

Merged
merged 24 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8e87784
Project skeleton for Postmark
bparmar-crest Oct 16, 2024
f94b784
Merge branch 'DataDog:master' into postmark-assets-v1.0.0
bparmar-crest Oct 23, 2024
bf32ab5
Postmark assets v1.0.0
bparmar-crest Oct 23, 2024
816b87c
CI assets fixed
bparmar-crest Oct 23, 2024
7730390
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Oct 29, 2024
05d0095
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Oct 30, 2024
78fcb95
review comments incorporated
bparmar-crest Oct 30, 2024
f31f180
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Nov 6, 2024
864c43e
README statement corrected
bparmar-crest Nov 6, 2024
c338525
Integration names removed from Monitors
bparmar-crest Nov 6, 2024
7c69bd0
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Nov 7, 2024
9e9962c
Monitors name modified in manifest.json
bparmar-crest Nov 7, 2024
10188c1
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Nov 7, 2024
278e86a
CODEOWNERS
bparmar-crest Nov 7, 2024
0a5ff64
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Dec 16, 2024
dc2e717
README.md modified
bparmar-crest Dec 16, 2024
5a47c04
Update postmark.yaml
rajshah-crest Dec 17, 2024
54eb229
Update postmark.yaml
rajshah-crest Dec 17, 2024
9e75fe0
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Dec 20, 2024
acedf40
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Dec 23, 2024
9b443e1
README changes
bparmar-crest Dec 23, 2024
b4d1fbb
Merge branch 'postmark-assets-v1.0.0' of github.com:bhargavnariyanicr…
bparmar-crest Dec 23, 2024
e4b9fad
Merge branch 'master' into postmark-assets-v1.0.0
bparmar-crest Jan 16, 2025
a85eb3b
review changes incorporated
bparmar-crest Jan 16, 2025
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
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,8 @@ integration/postfix:
- postfix/**/*
integration/postgres:
- postgres/**/*
integration/postmark:
- postmark/**/*
integration/powerdns_recursor:
- powerdns_recursor/**/*
integration/presto:
Expand Down
7 changes: 7 additions & 0 deletions postmark/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - Postmark

## 1.0.0 / 2024-10-14

***Added***:

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

[Postmark][1] is an email delivery service for sending and tracking application emails, offering a scalable alternative to traditional SMTP. It provides essential metrics, including sent, opened, bounced, and spam complaint rates, enabling effective email management and monitoring.

Integrate Postmark with Datadog to gain insights into Postmark broadcast and transactional message streams activity logs using [webhooks][2].

## Setup

Follow the instructions below to configure this integration for Postmark broadcast and transactional message streams activity logs through a webhook.

### Configuration
#### Enable open and link tracking in server settings for the message streams
Follow these steps to enable both features:

1. Log in to your [Postmark account][3]; this will redirect you to the [servers page][4].
2. Select the desired server; this will redirect you to the **Message Streams page**.
3. In the navigation panel, click on **Settings** tab.
4. In the Tracking section, enable both **Open tracking** and **Link tracking**.

#### Webhook configuration steps for broadcast message streams
Configure the Datadog endpoint to forward Postmark broadcast message streams activity logs to Datadog.

1. Select an existing API key or create a new one by clicking one of the buttons below:<!-- UI Component to be added by DataDog team -->
2. Log in to your [Postmark account][3]; this will redirect you to the [servers page][4].
3. Select the desired server; this will redirect you to the **Message Streams page**.
4. In the message streams page, select an existing broadcast message stream or create a new one by clicking the **Create Message Stream** button (enter a stream name and select the message type as **Broadcasts**).
5. In the navigation panel, click on **Webhooks** tab.
6. Click on the **Add Webhook** button.
7. Enter the webhook URL provided from step 1.
8. Choose the types of events you want to push to DataDog.
9. Click **Save webhook**.


#### Webhook configuration steps for transactional message streams
Configure the Datadog endpoint to forward Postmark transactional message streams activity logs to Datadog.

1. Select an existing API key or create a new one by clicking one of the buttons below:<!-- UI Component to be added by DataDog team -->
2. Log in to your [Postmark account][3]; this will redirect you to the [servers page][4].
3. Select the desired server; this will redirect you to the **Message Streams page**.
4. In the message streams page, select an existing transactional message stream or create a new one by clicking the **Create Message Stream** button (enter a stream name and select the message type as **Transactional**).
5. In the navigation panel, click on **Webhooks** tab.
6. Click on the **Add Webhook** button.
7. Enter the webhook URL provided from step 1.
8. Choose the types of events you want to push to DataDog.
9. Click **Save webhook**.

## Data Collected

### Logs
The Postmark integration forwards the Postmark message streams activity logs to Datadog.

### Metrics
Postmark does not include any metrics.

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

### Events
Postmark does not include any events.

## Troubleshooting

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

[1]: https://postmarkapp.com/
[2]: https://postmarkapp.com/developer/webhooks/webhooks-overview
[3]: https://account.postmarkapp.com/login
[4]: https://account.postmarkapp.com/servers
[5]: https://docs.datadoghq.com/help/
Loading
Loading