Skip to content

[DEVECO-725] Document incident.task.* and incident.role.assigned as GA webhooks #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fanfernandes wants to merge 2 commits into
base: main
Choose a base branch
from
+67 −93
Open

[DEVECO-725] Document incident.task.* and incident.role.assigned as GA webhooks #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1af325e
[DEVECO-725] Document incident.task.* and incident.role.assigned as G…
fanfernandes May 20, 2026
4e89059
Update docs/webhooks/01-Overview.md
fanfernandes May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions docs/webhooks/01-Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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": "A description of the task",
"id": "PGR0VU2",
"summary": "A thing that needs to be done",
"type": "incident_task",
"status": "todo",
Copy link
Copy Markdown
Contributor

@swbradshaw swbradshaw May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A viewer of this event would probably ask, "What are the various status values"? Unfortunately we don't have that documented anywhere because there was never a public API implemented for Tasks and web hook event's don't have any OpenAPI doc associated with them.

"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
Expand Down
93 changes: 0 additions & 93 deletions docs/webhooks/20-Early-Access-Webhooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
```