project_column

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

Github Event project_column #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
project_columncreated
updated
moved
deleted
Last commit on default branchDefault 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 column on a project (classic) is created or modified. For activity related to projects (classic) or cards in a project (classic), use the project or project_card event instead. For more information about projects (classic), see “About projects (classic).” For information about the project column 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 column has been created or deleted.

on:
  project_column:
    types: [created, deleted]

Event Payload #

source

Activities: created, deleted, edited, moved

Common Fields #

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

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.installationobjectoptional

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.organizationobjectoptional

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_columnobjectrequired
github.event.project_column.after_idinteger or nulloptional
github.event.project_column.cards_urlstringrequired
github.event.project_column.created_atstringrequired
github.event.project_column.idintegerrequired

The unique identifier of the project column

github.event.project_column.namestringrequired

Name of the project column

github.event.project_column.node_idstringrequired
github.event.project_column.project_urlstringrequired
github.event.project_column.updated_atstringrequired
github.event.project_column.urlstringrequired
github.event.repositoryobjectoptional

The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.

created #

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

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

fieldtyperequireddescription
github.event.actioncreatedrequired
github.event.senderobjectoptional

The GitHub user that triggered the event. This property is included in every webhook payload.

deleted #

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

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

fieldtyperequireddescription
github.event.actiondeletedrequired
github.event.senderobjectoptional

The GitHub user that triggered the event. This property is included in every webhook payload.

edited #

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

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

fieldtyperequireddescription
github.event.actioneditedrequired
github.event.changesobjectrequired
github.event.changes.nameobjectoptional
github.event.changes.name.fromstringrequired
github.event.senderobjectoptional

The GitHub user that triggered the event. This property is included in every webhook payload.

moved #

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

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.

fieldtyperequireddescription
github.event.actionmovedrequired
github.event.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.