Skip to content
Preview of the Incident postmortem (Markdown) template

210 × 297 mm

Reports

Incident postmortem (Markdown)

A blameless incident postmortem in Markdown: severity and impact at a glance, a minute-by-minute timeline table, root cause and contributing factors, what went well, and follow-up actions with owners and due dates — rendered to an A4 PDF.

PDFA4 portraitLocale en-GBMarkdown

Opens Dynamic Document API with this template preloaded in a free workspace.

Generating this from your own data? See the Report Generation API.

Template language features

  • Loops
  • Conditionals
  • Filters
  • Date formatting
  • Number formatting
  • Markdown

Filters such as format_currency and qrcode are described in the template language reference.

Variables

Derived from the sample data: 7 top-level fields, 25 paths in total. Send the same shape as data.

PathTypeExample
incidentobject
incident.idstring"INC-2026-0917"
incident.titlestring"Checkout payments failed for 47 minutes"
incident.severitystring"SEV2"
incident.statusstring"Resolved"
incident.started_atdate"2026-09-17T13:02:00Z"
incident.authorstring"Hana Novak (on-call engineer)"
incident.summarystring"After a routine deploy, the payment service co…"
incident.customer_notestring"Status page updated at 14:12 and 14:52; affect…"
impactobject
impact.duration_minutesnumber47
impact.customers_affectednumber3184
impact.failed_requestsnumber11420
impact.detected_bystring"Error-rate alert"
timelinearray<object> · 7
timeline[].atdate"2026-09-17T13:02:00Z"
timeline[].textstring"Deploy 2026.09.17-2 of the payment service sta…"
root_causestring"The deploy lowered the maximum number of outbo…"
contributing_factorsarray<string> · 3"Staging traffic is too low to exhaust a pool o…"
went_wellarray<string> · 3"The alert fired four minutes after the deploy,…"
actionsarray<object> · 4
actions[].textstring"Separate staging and production defaults in th…"
actions[].ownerstring"Platform team"
actions[].duedate"2026-09-26"
actions[].prioritystring"High"

Render it with the API

After adding the template to your workspace, render it by ID and pass your data. Arrays are shortened here.

curl -X POST https://api-eu.dynamicdocumentapi.com/v1/renders \
  -H "Authorization: Bearer $DYNAMIC_DOCUMENT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "type": "template",
    "template_id": "tpl_01J9ZK3M7Q8V5W2X4Y6Z8A0B1C"
  },
  "data": {
    "incident": {
      "id": "INC-2026-0917",
      "title": "Checkout payments failed for 47 minutes",
      "severity": "SEV2",
      "status": "Resolved",
      "started_at": "2026-09-17T13:02:00Z",
      "author": "Hana Novak (on-call engineer)",
      "summary": "After a routine deploy, the payment service could not reach the card processor because a new connection-pool limit was set too low. About a third of checkout attempts failed until the change was rolled back. No payments were charged twice and no data was lost.",
      "customer_note": "Status page updated at 14:12 and 14:52; affected customers received an email with a 10 % voucher on 18 September."
    },
    "impact": {
      "duration_minutes": 47,
      "customers_affected": 3184,
      "failed_requests": 11420,
      "detected_by": "Error-rate alert"
    },
    "timeline": [
      {
        "at": "2026-09-17T13:02:00Z",
        "text": "Deploy 2026.09.17-2 of the payment service starts."
      },
      {
        "at": "2026-09-17T13:06:00Z",
        "text": "Checkout error rate rises from 0.2 % to 31 %; alert fires."
      }
    ],
    "root_cause": "The deploy lowered the maximum number of outbound connections from 200 to 20 as part of a config clean-up. At lunchtime traffic the pool ran out within minutes, and requests waited until they timed out. The default in the new config template was meant for the staging environment.",
    "contributing_factors": [
      "Staging traffic is too low to exhaust a pool of 20 connections, so the load test passed.",
      "The config change was bundled with an unrelated feature and was not called out in the review."
    ],
    "went_well": [
      "The alert fired four minutes after the deploy, well before the first customer report.",
      "Idempotency keys prevented any double charges during retries."
    ],
    "actions": [
      {
        "text": "Separate staging and production defaults in the config template",
        "owner": "Platform team",
        "due": "2026-09-26",
        "priority": "High"
      },
      {
        "text": "Add a load test that reaches production peak traffic",
        "owner": "Quality team",
        "due": "2026-10-10",
        "priority": "High"
      }
    ]
  },
  "output": {
    "format": "pdf",
    "filename": "incident-postmortem-markdown.pdf"
  }
}'