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

Github Event `project_card` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`project_card`	- `created` - `moved` - `converted` to an issue - `edited` - `deleted`	Last commit on default branch	Default branch

Note: More than one activity type triggers this event. 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 card on a project (classic) is created or modified. For activity related to projects (classic) or columns in a project (classic), use the project or project_column event instead. For more information about projects (classic), see “About projects (classic).” For information about the project card 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 card has been created or deleted.

on:
  project_card:
    types: [created, deleted]

Event Payload #

source

Activities: converted, created, deleted, edited, moved

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_card`	object	required
`github.event.project_card.archived`	boolean	required	Whether or not the card is archived
`github.event.project_card.column_url`	string	required
`github.event.project_card.content_url`	string	optional
`github.event.project_card.created_at`	string	required
`github.event.project_card.creator`	object or null	required
`github.event.project_card.creator.avatar_url`	string	optional
`github.event.project_card.creator.deleted`	boolean	optional
`github.event.project_card.creator.email`	string or null	optional
`github.event.project_card.creator.events_url`	string	optional
`github.event.project_card.creator.followers_url`	string	optional
`github.event.project_card.creator.following_url`	string	optional
`github.event.project_card.creator.gists_url`	string	optional
`github.event.project_card.creator.gravatar_id`	string	optional
`github.event.project_card.creator.html_url`	string	optional
`github.event.project_card.creator.id`	integer	required
`github.event.project_card.creator.login`	string	required
`github.event.project_card.creator.name`	string	optional
`github.event.project_card.creator.node_id`	string	optional
`github.event.project_card.creator.organizations_url`	string	optional
`github.event.project_card.creator.received_events_url`	string	optional
`github.event.project_card.creator.repos_url`	string	optional
`github.event.project_card.creator.site_admin`	boolean	optional
`github.event.project_card.creator.starred_url`	string	optional
`github.event.project_card.creator.subscriptions_url`	string	optional
`github.event.project_card.creator.url`	string	optional
`github.event.project_card.id`	integer	required	The project card’s ID
`github.event.project_card.node_id`	string	required
`github.event.project_card.note`	string or null	required
`github.event.project_card.project_url`	string	required
`github.event.project_card.updated_at`	string	required
`github.event.project_card.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.
`github.event.sender`	object	required	The GitHub user that triggered the event. This property is included in every webhook payload.

`converted` #

This event occurs when there is activity relating to a card on 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.