Skip to content

Document template · generic.customer.incident_report

Customer Incident Report

  • Render-verified
  • Commercial
  • Version 1.0.0

Customer-facing incident / post-mortem report delivered by a vendor to an affected customer. Distinct from internal security-incident documentation: this is the communication the customer receives with incident identification, severity, detection/resolution timestamps, customer-visible impact, root cause, event-level timeline, corrective and preventive actions, and any service credits. Format follows the ICS / ITIL v4 post-incident review vocabulary.

JSON Schema

Fields in this template

Data sent to the API is validated against the template’s JSON Schema before anything is rendered. This template defines 26 fields:

Field Required Type Description
vendor Required object
vendor.name Required string
vendor.address Required string
vendor.contact_email Required string
customer Required object
customer.name Required string
customer.account_id Required string
incident_id Required string
severity Required enum
detected_on Required string
resolved_on Required string
duration Required string Human-readable duration, e.g. '3h 52m'.
impact_on_customer Required string Plain-language description of what the customer actually experienced.
root_cause Required string Prose RCA (what happened, why it happened, contributing factors).
timeline Required array of object
timeline[].timestamp Required string
timeline[].event Required string
corrective_actions Required array of string
preventive_actions Required array of string
service_credits_optional Optional object
service_credits_optional.amount Required number
service_credits_optional.currency Required string
signatory Required object
signatory.name Required string
signatory.title Required string
signatory.date Required date

POST /render

Generate it

One POST /render call: send your JSON, get the finished PDF back. Or skip the JSON entirely and describe the document in plain language on chut.app.

curl
curl -X POST https://api.papii.eu/render \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "generic.customer.incident_report",
    "data": { ... },
    "options": {"language": "en"}
  }' -o incident-report.pdf

Frequently asked questions

What is “Customer Incident Report”?

Customer-facing incident / post-mortem report delivered by a vendor to an affected customer. Distinct from internal security-incident documentation: this is the communication the customer receives with incident identification, severity, detection/resolution timestamps, customer-visible impact, root cause, event-level timeline, corrective and preventive actions, and any service credits. Format follows the ICS / ITIL v4 post-incident review vocabulary. On papii this document is available as template generic.customer.incident_report: a JSON Schema plus a deterministic PDF renderer, so the same data always produces the same document.

Can I generate a Customer Incident Report with AI?

Yes. chut.app — the AI back office papii powers — fills this template from a plain-language description: you describe the document in one sentence, the AI structures the data, papii validates it against the schema and renders the PDF. Developers can also call the papii API directly with structured JSON.

Is the Customer Incident Report template legally compliant?

This template is render-verified: its schema, sample data and PDF output are automatically tested on every release. It is published with status “ready”, meaning it has not yet been through papii’s final legal review. Where it references specific legislation, that is stated in the template description — always have a professional check documents with legal effect before relying on them.