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.

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

Clarify that the v3 Webhook event.agent can be null #115

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Clarify that the v3 Webhook event.agent can be null #115

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4fc4d9b
Indicate `event.agent` can be null
metavida Dec 13, 2024
5e6b4e7
Add a sentence describing when `event.agent` might be `null`
metavida Dec 13, 2024
43fa95a
Specify that `event.agent` is a Resource Reference
metavida Dec 13, 2024
30cb8cf
Clarify that the `event.client` can have a `null` value
metavida Dec 13, 2024
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
4 changes: 2 additions & 2 deletions docs/webhooks/01-Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ Each webhook payload contains a single event object. This event object contains
| `event.event_type` | String | The type of the event. This usually provides a description of what happened (e.g. `incident.priority_updated`). |
| `event.resource_type` | String | The root resource type (leftmost part of the `event_type`) this event is about (currently `incident` or `service`). It can be different from the more specific `data.type` in the event payload. |
| `event.occurred_at` | DateTime | An ISO 8601 datetime indicating when the event occurred. |
| `event.agent` | Object | Indicates who or what initiated the event. |
| `event.client` | Object | Information about where the event was triggered. |
| `event.agent` | a [Resource Reference](https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTYw-resource-references) or `null` | Indicates who or what initiated the event. A `null` value might indicate an event triggered via automation rather than a specific person. |
| `event.client` | Object or `null` | Information about where the event was triggered. |
| `event.data` | Object | Data specific to the `event_type` that occurred. |

An example webhook payload for an `incident.priority_updated` event is shown below.
Expand Down