From 1af325e62907a322cf7d0ffc89f614a129272686 Mon Sep 17 00:00:00 2001 From: fanfernandes Date: Wed, 20 May 2026 11:37:56 +0100 Subject: [PATCH 1/2] [DEVECO-725] Document incident.task.* and incident.role.assigned as GA webhooks Move four event types and two data-type schemas from Early Access docs to 01-Overview.md. Companion to webhook_composition_service PR #970. --- docs/webhooks/01-Overview.md | 67 ++++++++++++++++ docs/webhooks/20-Early-Access-Webhooks.md | 93 ----------------------- 2 files changed, 67 insertions(+), 93 deletions(-) diff --git a/docs/webhooks/01-Overview.md b/docs/webhooks/01-Overview.md index da49194..1bedcbb 100644 --- a/docs/webhooks/01-Overview.md +++ b/docs/webhooks/01-Overview.md @@ -232,8 +232,12 @@ Outbound events are created when PagerDuty resources change in interesting ways. | incident.resolved | `incident` | Sent when an incident is resolved. | `incidents.read` | | incident.responder.added | `incident_responder` | Sent when a responder has been added to an incident. | `incidents.read` | | incident.responder.replied | `incident_responder` | Sent when a responder replies to a request. | `incidents.read` | +| incident.role.assigned | `incident_role_assignment` | Sent when an incident role is assigned or unassigned. | `incidents.read` | | incident.service_updated | `incident` | Sent when the service of an incident has changed. | `incidents.read` | | incident.status_update_published | `incident_status_update` | Sent when a status update is added to an incident. | `incidents.read` | +| incident.task.completed | `incident_task` | Sent when an incident task is completed. | `incidents.read` | +| incident.task.created | `incident_task` | Sent when an incident task is created. | `incidents.read` | +| incident.task.updated | `incident_task` | Sent when an incident task is updated. | `incidents.read` | | incident.triggered | `incident` | Sent when an incident is newly created/triggered. | `incidents.read` | | incident.unacknowledged | `incident` | Sent when an incident is unacknowledged. | `incidents.read` | | incident.action_invocation.created | `incident_action_invocation` | Sent when an incident action invocation is created. | `incidents.read` | @@ -401,6 +405,40 @@ Depending on the `event.event_type`, of the webhook payload, the `event.data` fi } ```   +### incident_role_assignment +```json +{ + "type": "incident_role_assignment", + "incident_role_assignments": [ + { + "assignee": { + "html_url": "https://acme.pagerduty.com/users/P75B6QD", + "id": "P75B6QD", + "self": "https://api.pagerduty.com/users/P75B6QD", + "summary": "User 1810194", + "type": "user_reference" + }, + "id": "af64b84c-137e-40c6-875c-5dd30a2afaaa", + "incident": { + "html_url": "https://acme.pagerduty.com/incidents/PBAZLIU", + "id": "PBAZLIU", + "self": "https://api.pagerduty.com/incidents/PBAZLIU", + "summary": null, + "type": "incident_reference" + }, + "old_assignee": null, + "role": { + "id": "P8PQO4R", + "summary": "Role Display Name", + "type": "role_reference" + }, + "status": "active", + "type": "role_assignment_reference" + } + ] + } +``` +  ### incident_status_update ```json @@ -450,6 +488,35 @@ Depending on the `event.event_type`, of the webhook payload, the `event.data` fi } ```   +### incident_task + +```json +{ + "name": "A thing that needs to be done", + "description": null, + "id": "PGR0VU2", + "summary": "A thing that needs to be done", + "type": "incident_task", + "status": "todo", + "assignees": [ + { + "html_url": "https://acme.pagerduty.com/users/PIV35G6", + "id": "PIV35G6", + "self": "https://api.pagerduty.com/users/PIV35G6", + "summary": "User 661768438", + "type": "user_reference" + } + ], + "incident": { + "html_url": "https://acme.pagerduty.com/incidents/Q0SDD3HB6SGFTI", + "id": "Q0SDD3HB6SGFTI", + "self": "https://api.pagerduty.com/incidents/Q0SDD3HB6SGFTI", + "summary": null, + "type": "incident_reference" + } +} +``` +  ### incident_workflow_instance ```json diff --git a/docs/webhooks/20-Early-Access-Webhooks.md b/docs/webhooks/20-Early-Access-Webhooks.md index 5fb1ca1..5b70b3e 100644 --- a/docs/webhooks/20-Early-Access-Webhooks.md +++ b/docs/webhooks/20-Early-Access-Webhooks.md @@ -14,96 +14,3 @@ tags: [webhooks] Early Access webhook events are provided here for informational purposes, but are subject to change in availability (may be removed) and design (contents and shape of response may change). They can be created via the `/webhook_subscriptions` REST API endpoint. - -## Event Types - -### incident.task.created - -`data.type` is [`incident_task`](#incident_task) - -Sent when an incident task is created. - -### incident.task.updated - -`data.type` is [`incident_task`](#incident_task) - -Sent when an incident task is updated. - -### incident.task.completed - -`data.type` is [`incident_task`](#incident_task) - -Sent when an incident task is completed. - -### incident.role.assigned - -`data.type` is [`incident_role_assignment`](#incident_role_assignment) - -Sent when an incident role is assigned or unassigned. - -## Event Data Types - -Depending on the `event.event_type`, of the webhook payload, the `event.data` field will contain one of the objects described in this section. - -### incident_task - -```json -{ - "name": "A thing that needs to be done", - "description": null, - "id": "PGR0VU2", - "summary": "A thing that needs to be done", - "type": "incident_task", - "status": "todo", - "assignees": [ - { - "html_url": "https://acme.pagerduty.com/users/PIV35G6", - "id": "PIV35G6", - "self": "https://api.pagerduty.com/users/PIV35G6", - "summary": "User 661768438", - "type": "user_reference" - } - ], - "incident": { - "html_url": "https://acme.pagerduty.com/incidents/Q0SDD3HB6SGFTI", - "id": "Q0SDD3HB6SGFTI", - "self": "https://api.pagerduty.com/incidents/Q0SDD3HB6SGFTI", - "summary": null, - "type": "incident_reference" - } -} -``` - -### incident_role_assignment -```json -{ - "type": "incident_role_assignment", - "incident_role_assignments": [ - { - "assignee": { - "html_url": "https://acme.pagerduty.com/users/P75B6QD", - "id": "P75B6QD", - "self": "https://api.pagerduty.com/users/P75B6QD", - "summary": "User 1810194", - "type": "user_reference" - }, - "id": "af64b84c-137e-40c6-875c-5dd30a2afaaa", - "incident": { - "html_url": "https://acme.pagerduty.com/incidents/PBAZLIU", - "id": "PBAZLIU", - "self": "https://api.pagerduty.com/incidents/PBAZLIU", - "summary": null, - "type": "incident_reference" - }, - "old_assignee": null, - "role": { - "id": "P8PQO4R", - "summary": "Role Display Name", - "type": "role_reference" - }, - "status": "active", - "type": "role_assignment_reference" - } - ] - } -``` From 4e89059c572a4ebe6bf5c3e725113aa213f3abb1 Mon Sep 17 00:00:00 2001 From: fanfernandes <113178642+fanfernandes@users.noreply.github.com> Date: Thu, 21 May 2026 14:17:01 +0100 Subject: [PATCH 2/2] Update docs/webhooks/01-Overview.md Co-authored-by: Scott Bradshaw --- docs/webhooks/01-Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/webhooks/01-Overview.md b/docs/webhooks/01-Overview.md index 1bedcbb..7ed31fb 100644 --- a/docs/webhooks/01-Overview.md +++ b/docs/webhooks/01-Overview.md @@ -493,7 +493,7 @@ Depending on the `event.event_type`, of the webhook payload, the `event.data` fi ```json { "name": "A thing that needs to be done", - "description": null, + "description": "A description of the task", "id": "PGR0VU2", "summary": "A thing that needs to be done", "type": "incident_task",