Please document `on: schedule` event payload

[vlsi]

From what I see the schedule event contains just a single field with the schedule itself, however, it is not documented.

[gr2m]

Thanks Vladimir for bringing this to our attention. We currently include all events that are documented on this page:
https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads

The schedule event is currently not documented, because it's not a webhook that is sent to external servers via http, it is an internal event used exclusively for GItHub Actions. That being said, the same is true for the workflow_dispatch event.

I'm not sure what the right course of action here is, I've contacted GitHub's documentation team to see what they think. I'll keep you posted

[wolfy1339]

Is there any development on this issue?

[gr2m]

I think the right thing to do here is to wait until we create @octokit/events, which would have all the events, and use @octokit/webhooks for only the webhooks logic (signature verification, request handling)

[gr2m]

For the record, I just needed to know what the event payload looks like for the schedule event, and it just has the schedule key

{
  "schedule": "*/5 * * * *"
}

[stdavis]

Did anything ever happen with this issue? I'm also looking for documentation on schedule even payload. It appears to have repository as well.

[wolfy1339]

It's not in the current scope of this repository, we only handle webhooks, and not Github Actions events