Skip to content
Latchkey

What Is GITHUB_EVENT_PATH?

GITHUB_EVENT_PATH is the filesystem path to a JSON file containing the complete event payload.

When the built-in variables are not enough, GITHUB_EVENT_PATH gives you the entire webhook payload to read with jq or a script.

Example

Read the PR title from the payload.

shell
jq -r .pull_request.title "${GITHUB_EVENT_PATH}"

Key takeaways

  • GITHUB_EVENT_PATH points to the event JSON.
  • Read it with jq for any field.
  • Use it when built-in vars fall short.

Related guides

Tired of flaky CI? Latchkey auto-heals failed jobs and retries them for you. Start free →