jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-26 14:02:45 -05:00
Code Issues Projects Releases Wiki Activity
Files
d5babbfbade4d24943ea5cb8d76bf5a7a3538747
docs/lib/webhooks/static/dotcom
History
Patrick Ellis 4b5e01365c Use in_progress workflow_job example, not queued (#22880) 
* Use in_progress workflow_job example, not queued

### tl;dr

This changes the example `workflow_job` payload to be an `in_progress` event instead of `queued` event.

### why

In #22174, I added some keys to the example workflow_job json. This was correct, but by adding non-null _values_, **I introduced a subtle bug**.

It's a bug because a `queued` workflow is—by definition—_not_ yet assigned to a runner. So all the `runner_*` attributes will be `null` in the real world. 

After the workflow becomes `in_progress`, all the values are guaranteed to exist. So let's change the example to be an `in_progress` event, since it's a better example for documentation.

* Explain more about the runner_* attributes in "workflow_job_properties.md"

* Consistentize naming

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2021-11-17 15:48:31 +00:00
..
branch_protection_rule.edited.payload.json
Add documentation for branch protection rule webhook (#21177)
2021-08-31 14:43:03 +00:00
check_run.completed.payload.json
Environments API (#17898)
2021-02-23 11:35:38 -08:00
check_run.created.payload.json
Environments API (#17898)
2021-02-23 11:35:38 -08:00
check_run.rerequested.payload.json
Environments API (#17898)
2021-02-23 11:35:38 -08:00
check_suite.completed.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
check_suite.requested.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
check_suite.rerequested.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
code_scanning_alert.reopened.payload.json
Update webhook examples
2021-03-12 11:41:29 +00:00
commit_comment.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
content_reference.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
create.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
delete.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
deploy_key.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
deployment_status.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
deployment.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
discussion_comment.created.payload.json
Add webhook events for discussions (#18442)
2021-03-30 17:38:13 +00:00
discussion.created.payload.json
Add webhook events for discussions (#18442)
2021-03-30 17:38:13 +00:00
fork.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
github_app_authorization.revoked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
gollum.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
installation_repositories.added.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
installation_repositories.removed.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
installation.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
installation.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
integration_installation_repositories.added.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
integration_installation.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issue_comment.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issue_comment.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issue_comment.edited.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.assigned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.demilestoned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.edited.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.labeled.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.locked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.milestoned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.opened.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.unassigned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.unlabeled.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
issues.unlocked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
label.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
label.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
label.edited.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
marketplace_purchase.cancelled.payload.json
Account objects in marketplace purchase webhook event also have node_id (#16772)
2020-12-15 07:19:09 +00:00
marketplace_purchase.changed.payload.json
Account objects in marketplace purchase webhook event also have node_id (#16772)
2020-12-15 07:19:09 +00:00
marketplace_purchase.purchased.payload.json
Account objects in marketplace purchase webhook event also have node_id (#16772)
2020-12-15 07:19:09 +00:00
member.added.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
member.edited.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
membership.added.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
membership.removed.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
meta.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
milestone.closed.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
milestone.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
milestone.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
org_block.blocked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
org_block.unblocked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
organization.member_added.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
package.published.payload.json
Update Packages docs for Container registry GA (#19987)
2021-06-21 15:10:12 -04:00
page_build.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
ping.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
project_card.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
project_column.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
project.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
public.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request_review_comment.created.payload.json
fix typo found by @adityatheoctocatdev (#20303)
2021-07-12 15:15:57 -07:00
pull_request_review.submitted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.assigned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.closed.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.labeled.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.locked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.opened.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.unassigned.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.unlabeled.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
pull_request.unlocked.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
push.payload.json
webhooks: document the undocumented pieces of the push webhook (#21792)
2021-10-01 15:31:43 -07:00
release.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
release.published.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
repository_dispatch.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
repository_import.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
repository_vulnerability_alert.create.payload.json
Adding to RVA payload (#18925)
2021-04-30 15:06:03 -07:00
repository_vulnerability_alert.dismiss.payload.json
Adding to RVA payload (#18925)
2021-04-30 15:06:03 -07:00
repository.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
repository.privatized.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
repository.publicized.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
secret_scanning_alert.reopened.payload.json
Secret scanning webhooks & APIs (#16608)
2020-12-04 09:39:29 +10:00
security_advisory.published.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
sponsorship.created.payload.json
Add new fields to sample Sponsors webhooks (#18548)
2021-04-02 17:11:58 +00:00
sponsorship.downgraded.payload.json
Add new fields to sample Sponsors webhooks (#18548)
2021-04-02 17:11:58 +00:00
star.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
star.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
status.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
team_add.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
team.added_to_repository.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
team.created.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
team.deleted.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
team.edited.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
watch.started.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
workflow_dispatch.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00
workflow_job.payload.json
Use in_progress workflow_job example, not queued (#22880)
2021-11-17 15:48:31 +00:00
workflow_run.payload.json
Hello git history spelunker!
2020-09-27 14:10:11 +02:00