Add Note to an Incident
PagerDuty Incident Management
Availability
This workflow action is available on our Business and Enterprise for Incident Management pricing plans. Please contact our Sales Team to upgrade to an account with this action.
Description
This action adds a note to an existing incident, which will also be visible in the incident timeline. You can use notes to provide updates, context, or additional information about the incident's resolution process.
Incident Note Limitations
The following limitations apply to notes on both open and resolved incidents:
- An incident can have up to 2,000 notes.
- Incident notes are limited to 65,535 single-byte characters. This typically equates to ~16,000 characters of UTF-8 encoded text.
- Once added, incident notes cannot be edited or deleted.
Instructions
- If you have not done so already, please follow our instructions to Create an Incident Workflow.
- When you are prompted to add actions , select this action.
- Enter the following Inputs and then click Save. Continue following instructions to Publish the Workflow. When the action runs, you will see the Outputs listed below.
Inputs
Field References
Fields with the {+} icon accept Field References, which can be useful for referencing incident data or outputs created in prior workflow steps. To add Field References, click {+}, or enter
{{
, and select relevant fields. Please see our Field References article for more information.
Name | Description |
---|---|
Incident ID | Required: The ID of the incident where you’re adding the note (defaults to current incident ID) |
Message | Required: The note’s message text |
Assigned User ID | Hidden: The ID of the user assigned to the incident. If there are multiple assigned users, this defaults to the ID of the first user |
Outputs
Name | Description |
---|---|
Result | Value that shows if the action was successful or not. Either "Success" or "Failed" |
Result Summary | Brief description of what the action did or if it failed. |
Error | Brief description that is populated if the action failed. |
PagerDuty API Endpoint
Endpoint used:
Updated 17 days ago