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

Update Codescanning Webhook Docs to Include Default Sender Field #3565

Closed
wants to merge 1 commit into from

Conversation

natashaU
Copy link
Contributor

@natashaU natashaU commented Feb 9, 2021

Why:

We're adding GitHub as the default sender field in the code-scanning alert payload.

What's being changed:

Hi there 👋

I'm from the codescanning Team at GitHub and we're doing a slight update. Previously:

sender object If the action is reopened_by_user or closed_by_user, the sender object will be the user that triggered the event. The sender object is empty for all other actions.

See here for more info: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert

Now, we'll include a default sender object instead of having that field be empty and want the docs to reflect the default field value.

Related Links:

payload example PR: octokit/webhooks#366 (comment)

cc/ @bogdanap @anaarmas @krukow

Check off the following:

@welcome
Copy link

welcome bot commented Feb 9, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@natashaU natashaU changed the title update codescanning docs to include sender field Update Codescanning Webhook Docs to Include Default Sender Field Feb 9, 2021
@natashaU natashaU marked this pull request as ready for review February 9, 2021 00:11
@shati-patel shati-patel removed the request for review from vanessayuenn February 9, 2021 09:45
@bogdanap bogdanap closed this Feb 9, 2021
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.

2 participants