repository_dispatch
The workflow event that lets a system outside the repository start a workflow by sending a custom event through the GitHub API.
In more detail
The caller needs a token with access to the repository and names an event type. The workflow can filter on that type and read a JSON payload the caller sends.
Related terms
- API — A defined way for one program to ask another program to do something, such as a list of web requests a service accepts.
- workflow event — Something that happens on GitHub, such as a push or a pull request, that can start a workflow run.
Taught in
- Triggers and the Event Model — Continuous Integration & Continuous Delivery Pipelines
- Triggers In Depth: Filters, Schedules And Dispatch — GitHub Actions (GH-200) Exam Prep
- GITHUB_TOKEN: Least Privilege, Job By Job — GitHub Actions (GH-200) Exam Prep