Skip to content
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.

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

Add changed_fields to incident tasks event payload #86

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
57 changes: 36 additions & 21 deletions docs/webhooks/20-Early-Access-Webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,27 +87,42 @@ 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,
"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"
"id": "2dd39544-ccd2-491d-9c5b-e4fb8be4259d",
"event_type": "incident.task.created",
"resource_type": "incident",
"occurred_at": "2021-06-01T21:30:42Z",
"agent": {
"html_url": "https://acme.pagerduty.com/users/PLH1HKV",
"id": "PLH1HKV",
"self": "https://api.pagerduty.com/users/PLH1HKV",
"summary": "User 10",
"type": "user_reference"
},
"client": null,
"data": {
"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"
},
"changed_fields": []
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be {}, but actually it's probably more helpful to have the event for incident.task.updated with an example change of some fields.

}
}
```