[mintlify]

Summary

Small, targeted updates to two existing pages to close documentation gaps surfaced by recent assistant conversations.

Changes

• API check env vars: Added a short "Preserving special characters with triple brackets" subsection explaining why & and other characters can break header values, and when to reach for {{{VAR}}} instead of {{VAR}}. The existing one-line note was easy to miss.
• Webhooks — OpsGenie: Renamed the example to "OpsGenie and Jira Service Management (JSM) Operations" and added a lead-in noting that JSM Operations shares the OpsGenie alerts API, so the same webhook payload works — users only need to swap the endpoint URL and API key.

Context

Assistant traffic in the last week showed users hitting confusion around HTML-escaped env vars in headers (ampersand breaking API keys) and asking how to send Checkly alerts to JSM Operations now that OpsGenie is being wound down. Neither had a clear landing spot in the docs before.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
checkly-422f444a	🟢 Ready	View Preview	Nov 4, 2026, 1:58 AM

[hlenke]

Needs changes · Trim this PR to the JSM note: main already explains triple brackets on the API check page, and the branch conflicts with main on the webhooks heading.

Merge readiness

• Conflict. GitHub reports the PR as CONFLICTING. Since the merge base (260ea2a), main renamed the heading this PR edits from ### OpsGenie to ### Opsgenie (#734, casing), so the changed heading line conflicts. Rebase on main and use the Opsgenie spelling (see the inline suggestion).
• API check page is already covered on main. #591 (28738c0) rewrote the sentence at detect/synthetic-monitoring/api-checks/configuration.mdx:96 on main. It now says that double-bracket variables are HTML-escaped (& becomes &) and that triple brackets insert the raw value, for example for an API key or token. The new #### Preserving special characters with triple brackets subsection repeats that and adds nothing a reader needs. Drop the whole hunk in this file (inline comment).
• Overlap. Open PR #416 also edits detect/synthetic-monitoring/api-checks/configuration.mdx. Dropping this PR's hunk there removes the overlap.
• CI passes (Mintlify, docs-gate, preview-checks, static-docs-checks).
• Cross-file impact. Renaming the heading changes the #opsgenie anchor. No page on main links to webhooks#opsgenie, so nothing breaks.

Inline comments: 1 important, 1 wording.

What I checked

• Read the full diff 260ea2ae..refs/docs-review/pr-481 (2 files, +9/-1) and the PR's version of both pages.
• Compared it with origin/main. configuration.mdx:96 already covers the escaping and triple brackets (#591). webhooks.mdx:276 is now ### Opsgenie (#734). main also changed the retry and signature sections of webhooks.mdx (DOC-175, #744), which this PR does not touch.
• gh pr checks 481: all pass. gh pr view 481: mergeable=CONFLICTING, mergeStateStatus=DIRTY.
• pr_impact.py: only flags /integrations/alerts/webhooks as a hub page. Searched main for webhooks#opsgenie: no inbound links.
• "No dedicated JSM alert channel": the alert channel type enum in api-reference/openapi.json lists EMAIL, SLACK, SLACK_APP, WEBHOOK, SMS, PAGERDUTY, OPSGENIE and CALL. The checkly-cli constructs at origin/main@4e450744 and the monorepo API contract at origin/main@28c905592a have no JSM or Jira Service Management channel either.
• JSM endpoint and auth: Atlassian's integration events API reference (https://developer.atlassian.com/cloud/jira/service-desk-ops/rest/v1/api-group-integration-events/) gives POST https://api.atlassian.com/jsm/ops/integration/v2/alerts, with Authorization: GenieKey <apiKey> and Opsgenie-style body fields (message, description, responders, tags, and others).
• Could not verify: whether JSM accepts the API key in the URL userinfo (https://KEY@...), as the Opsgenie example below shows. The suggestion therefore names the header form only. I ran no end-to-end test: the remaining claim is about a third-party API, and testing it would need a JSM account.