This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event `project` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`project`	- `created` - `closed` - `reopened` - `edited` - `deleted`	Last commit on default branch	Default branch

Note: More than one activity type triggers this event. The edited activity type refers to when a project (classic), not a column or card on the project (classic), is edited. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see “Workflow syntax for GitHub Actions.”

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

Note: This event only occurs for projects owned by the workflow’s repository, not for organization-owned or user-owned projects or for projects owned by another repository.

Note: This event only occurs for projects (classic).

Runs your workflow when a project (classic) is created or modified. For activity related to cards or columns in a project (classic), use the project_card or project_column events instead. For more information about projects (classic), see “About projects (classic).” For information about the project (classic) APIs, see “Objects” in the GraphQL API documentation or “Projects (classic)” in the REST API documentation.

For example, you can run a workflow when a project has been created or deleted.

on:
  project:
    types: [created, deleted]

Event Payload #

source

Activities: closed, created, deleted, edited, reopened

Common Fields #

These fields are common to every event types available with this trigger.

field	type	required	description
`github.event.enterprise`	object	optional	An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."
`github.event.installation`	object	optional	The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."
`github.event.organization`	object	optional	A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.
`github.event.project`	object	required
`github.event.project.body`	string or null	required	Body of the project
`github.event.project.columns_url`	string	required
`github.event.project.created_at`	string	required
`github.event.project.creator`	object or null	required
`github.event.project.creator.avatar_url`	string	optional
`github.event.project.creator.deleted`	boolean	optional
`github.event.project.creator.email`	string or null	optional
`github.event.project.creator.events_url`	string	optional
`github.event.project.creator.followers_url`	string	optional
`github.event.project.creator.following_url`	string	optional
`github.event.project.creator.gists_url`	string	optional
`github.event.project.creator.gravatar_id`	string	optional
`github.event.project.creator.html_url`	string	optional
`github.event.project.creator.id`	integer	required
`github.event.project.creator.login`	string	required
`github.event.project.creator.name`	string	optional
`github.event.project.creator.node_id`	string	optional
`github.event.project.creator.organizations_url`	string	optional
`github.event.project.creator.received_events_url`	string	optional
`github.event.project.creator.repos_url`	string	optional
`github.event.project.creator.site_admin`	boolean	optional
`github.event.project.creator.starred_url`	string	optional
`github.event.project.creator.subscriptions_url`	string	optional
`github.event.project.creator.type`	`Bot`, `User`, `Organization`	optional
`github.event.project.creator.url`	string	optional
`github.event.project.html_url`	string	required
`github.event.project.id`	integer	required
`github.event.project.name`	string	required	Name of the project
`github.event.project.node_id`	string	required
`github.event.project.number`	integer	required
`github.event.project.owner_url`	string	required
`github.event.project.state`	`open`, `closed`	required	State of the project; either ‘open’ or ‘closed’
`github.event.project.updated_at`	string	required
`github.event.project.url`	string	required
`github.event.repository`	object	optional	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.

`closed` #

This event occurs when there is activity relating to a project (classic). For more information, see "About projects (classic)." For information about the API to manage classic projects, see the GraphQL API documentation or "Projects (classic)" in the REST API documentation.