gollum

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

Github Event gollum #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
gollumNot applicableLast commit on default branchDefault branch

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

Runs your workflow when someone creates or updates a Wiki page. For more information, see “About wikis.”

For example, you can run a workflow when the gollum event occurs.

on:
  gollum

Event Payload #

source

This event occurs when someone creates or updates a wiki page. For more information, see "About wikis."

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

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.pagesarray of objectsrequired

The pages that were updated.

github.event.pages.actioncreated, editedrequired

The action that was performed on the page. Can be created or edited.

github.event.pages.html_urlstringrequired

Points to the HTML wiki page.

github.event.pages.page_namestringrequired

The name of the page.

github.event.pages.shastringrequired

The latest commit SHA of the page.

github.event.pages.summarystring or nullrequired
github.event.pages.titlestringrequired

The current page title.

github.event.repositoryobjectrequired

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

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