Skip to content

PagerDuty: document parameters passthrough and templating gotcha#234

Merged
maximelb merged 2 commits into
masterfrom
docs/pagerduty-parameters
May 21, 2026
Merged

PagerDuty: document parameters passthrough and templating gotcha#234
maximelb merged 2 commits into
masterfrom
docs/pagerduty-parameters

Conversation

@maximelb
Copy link
Copy Markdown
Contributor

Summary

Updates the PagerDuty extension page with two things that came out of a recent incident:

  • A callout explaining the templating gotcha: bare strings under extension request are evaluated as gjson paths and silently dropped if they don't resolve. Wrap literals in {{ "..." }}. This is what caused customers to hit missing one of source even though the rule clearly had source: limacharlie.io.
  • A new section describing the parameters passthrough block being added in ext-pagerduty#35custom_details, links, images, timestamp, client, client_url, dedup_key — with a worked example showing a clickable link back to LimaCharlie and a dedup_key tied to the detection.

Depends on ext-pagerduty#35 landing first.

Test plan

  • mkdocs builds locally without errors
  • Table renders correctly in mkdocs-material theme
  • Callout admonition renders as expected

🤖 Generated with Claude Code

Add a callout explaining that bare strings under `extension request`
are interpreted as gjson paths and silently dropped if they don't
resolve — wrap literals in `{{ "..." }}`. Add a section describing
the new `parameters` block (custom_details, links, images, timestamp,
client, client_url, dedup_key) and a worked example showing a
clickable link back to LimaCharlie and a dedup_key tied to the
detection.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@maximelb maximelb requested a review from steveatlc May 21, 2026 00:24
@maximelb maximelb added the to-code-review Used to tag PRs that are force-pushed and will need to be reviewed after the fact. label May 21, 2026
@maximelb maximelb marked this pull request as ready for review May 21, 2026 00:24
- alternate-targets.md: rename `pagerduty` → `ext-pagerduty` and switch
  the request body key from the legacy `request:` to `extension request:`.
- dr-rule-building-guidebook.md: rename `pagerduty` → `ext-pagerduty`
  and add the required `source` field so the example actually validates
  (the extension requires summary + source + severity).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@maximelb maximelb merged commit f25aaae into master May 21, 2026
2 checks passed
@maximelb maximelb deleted the docs/pagerduty-parameters branch May 21, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

to-code-review Used to tag PRs that are force-pushed and will need to be reviewed after the fact.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant