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

4752 Updated documentation regarding Webhooks v2 #4878

Merged
merged 4 commits into from
Jan 3, 2025

Conversation

albertisfu
Copy link
Contributor

@albertisfu albertisfu commented Jan 2, 2025

This PR Fixes #4752

I've applied the following updates:

  • Updated the screenshots in /help/api/webhooks/getting-started/ to reflect the new Version field on the webhook UI.
  • Updated the description in /help/api/webhooks/getting-started/#setup-a-webhook to include the step of selecting the webhook version during the setup process. The description now links to the Webhook Change Log section for more details about the versions:
    Screenshot 2025-01-01 at 6 50 18 p m
  • Updated the Change Log in /help/api/webhooks/v2#change-log to include details about the updates in v2:
    Screenshot 2025-01-01 at 6 51 54 p m
  • Fixed an issue where the Search Alert Test Event for a v2 endpoint was still displaying the test payload for v1. I resolved this by introducing a new test event template specifically for v2 Search Alert type events:
    Screenshot 2025-01-01 at 6 53 55 p m

@albertisfu albertisfu marked this pull request as ready for review January 2, 2025 00:58
@albertisfu albertisfu requested a review from mlissner January 2, 2025 00:58
Copy link
Member

@mlissner mlissner left a comment

Choose a reason for hiding this comment

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

A couple thoughts, but looks great to me otherwise. Thank you!

cl/api/templates/webhooks-docs-vlatest.html Outdated Show resolved Hide resolved
cl/api/templates/webhooks-getting-started.html Outdated Show resolved Hide resolved
@albertisfu
Copy link
Contributor Author

Thanks, suggestions are now applied.

@mlissner mlissner merged commit 3060ac0 into main Jan 3, 2025
15 checks passed
@mlissner mlissner deleted the 4752-document-webhooks-v2 branch January 3, 2025 20:12
@mlissner
Copy link
Member

mlissner commented Jan 3, 2025

Thanks, looks great!

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

Successfully merging this pull request may close these issues.

Document webhooks v2
2 participants