For AI agents and assistants: visit https://docs.pagerduty.com/llms.txt for the index.

Render a template

Render a template. This endpoint has a variable request body depending on the template type. For the status_update template type, the caller will provide the incident id, and a status update message.

Scoped OAuth requires: templates.read

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the resource.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

incident_id?string

The incident id to render the template for

status_update?

external?unknown

An optional object collection that can be referenced in the template.

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/templates/{id}/render" \  -H "Content-Type: application/json" \  -d '{    "incident_id": "QT4KHLK034QWE34",    "status_update": {      "message": "Status update message"    }  }'

{  "templated_fields": {    "email_subject": "Update: Status update message",    "email_body": "<div class=\"test\">Status update message</div>",    "message": "Update: Status update message"  },  "warnings": [    {      "email_body": [        "{{incident.bad_value}} does not exist."      ]    }  ],  "errors": []}

Render a template

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

402application/json

403application/json

404application/json

500application/json

Developer Agreement

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`