Skip to content

docs(integrations): rewrite the Datadog page as a webhook alert-source guide - #147

Merged
idanlodzki merged 2 commits into
OpsiMate:mainfrom
Apu-Emdad:docs/datadog-webhook-page
Oct 13, 2026
Merged

idanlodzki merged 2 commits into
OpsiMate:mainfrom
Apu-Emdad:docs/datadog-webhook-page

Conversation

@Apu-Emdad

Copy link
Copy Markdown
Contributor

Issue Reference

Closes OpsiMate/OpsiMate#1091


What Was Changed

Rewrote opsimate-docs/docs/integrations/datadog.md, following the structure of grafana.md. I checked it against createCustomDatadogAlert, DatadogAlertWebhookSchema and DatadogSetupModal.tsx in the main repo:

  • Webhook URL: http://<your-opsimate-host>:3001/api/v1/alerts/custom/datadog?api_token={your_api_token}, plus the X-API-Token header alternative (the auth middleware reads either).
  • API token: the same API_TOKEN section the Grafana page has.
  • Setting up the webhook in Datadog: Integrations → Webhooks → New, name it opsimate-alerts, paste the URL, then paste the custom payload exactly as the in-app guide shows it. Optionally add "priority": "$PRIORITY" for priority-based severity.
  • Attaching to monitors: add @webhook-opsimate-alerts in Notify, then trigger a test.
  • How the payload is read:
    • id, title and date are required, otherwise HTTP 400.
    • id identifies and updates the alert.
    • title becomes the name and message the summary.
    • link becomes a "View in Datadog" link.
  • Auto-resolve: an alert_transition containing Recovered resolves the alert with the same id.
  • Tags: each key:value entry in $TAGS becomes a tag, and entries without exactly one : are skipped.
  • Severity: a severity: tag wins. Otherwise priority is used: P1 → critical, P2–P3 → warning, P4–P5 → info. Unknown or missing → warning.
  • The Configure form: it still asks for URL, API key and Application key, but ingestion doesn't need them.
  • Front matter: tags changed from [Links, Monitoring Data] to [Alerts].
  • Official Resources: kept, plus a link to Datadog's webhooks integration docs.

Why Was It Changed

The page described dashboard links from services, which no longer exist, and said nothing about the webhook that is how OpsiMate actually gets Datadog alerts today.


Screenshots

Previewed locally, and npm run build passes with no broken-link or anchor warnings. A screenshot will be added in a follow-up comment.


Additional Context (Optional)

The in-app guide's note still says only "the first tag" from $TAGS is used. The server actually keeps every key:value tag, and this page documents the server behaviour.

…e guide

The page described dashboard links from services, which no longer exist.
Rewrite it after grafana.md around what OpsiMate does with Datadog today:
receiving monitor alerts at POST /api/v1/alerts/custom/datadog.

Cover the webhook URL (and the X-API-Token header), setting up the webhook
with the in-app custom payload, attaching it to monitors, how the payload
is read, auto-resolve on Recovered, tag parsing, severity from tags or
priority, and that the Configure form isn't needed for ingestion. Change
the front-matter tags to [Alerts] and keep the official resources.

Closes OpsiMate/OpsiMate#1091
@vercel

vercel Bot commented Oct 13, 2026

Copy link
Copy Markdown

@Apu-Emdad is attempting to deploy a commit to the idan lodzki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: OpsiMate/documentation/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3d9db041-1fa9-4db0-81cd-7b8a2a7abd77
📥 Commits

Reviewing files that changed from the base of the PR and between ac5eca2 and c49414d.

📒 Files selected for processing: 1
  • opsimate-docs/docs/integrations/datadog.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

- Use $ALERT_CYCLE_KEY for "id": $ID is a new event ID per notification, so recoveries never matched the triggering alert
- Use $ALERT_PRIORITY (monitor priority P1-P5) instead of $PRIORITY (event priority normal/low) for severity
- Point the API Documentation link at https://docs.datadoghq.com/api/
- Spell Datadog consistently in the title and resources

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@idanlodzki
idanlodzki merged commit 06e0ee5 into OpsiMate:main Oct 13, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: rewrite the Datadog page as a webhook alert-source guide

2 participants