Clarify that the v3 Webhook event.agent
can have a null
#115
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Before this change v3 Webhook Overview docs already implied that the
event.agent
can have anull
value because it's demonstrated in the "example webhook payload for a service.updated event is shown below."This PR makes the Webhook Payload documentation more clear via the following changes:
event.agent
object is specifically a Resource Reference.event.agent
object can have anull
value.event.client
object can have anull
value.It's worth nothing that I have not done a comprehensive analysis of whether other Webhook
event
fields can also havenull
values.Jira Ticket
Before Merging!