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

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

metavida
Copy link
Contributor

@metavida metavida commented Dec 13, 2024

Description

Before this change v3 Webhook Overview docs already implied that the event.agent can have a null 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:

  1. Specifies that the event.agent object is specifically a Resource Reference.
  2. Explicitly states that the event.agent object can have a null value.
  3. Explicitly states that the event.client object can have a null value.

It's worth nothing that I have not done a comprehensive analysis of whether other Webhook event fields can also have null values.

Jira Ticket

Before Merging!

  • Check staging environment to ensure changes look as intended.
    Monosnap Mozilla Firefox 2024-12-13 12-28-26
  • Ensure there is a review from SHAF Shared and from Community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant