What Syncs from GitHub

This page lists the GitHub webhook events Git-Zen acts on, and the events it ignores.

Events Git-Zen uses

GitHub webhook event	What Git-Zen does
Pushes	Adds commits with a gz# tag to the ticket. Comments if Upon commit push is on. Lists the affected files.
Issues	Updates the linked issue in the sidebar. Comments on the ticket for the changes below. Runs tag/label sync from GitHub.
Issue comments	Copies issue comments to the ticket if Upon issue comment is on.
Commit comments	Adds comments on linked commits to the ticket.
Releases	Comments on linked tickets when a release is published. See Release notifications.

Issue changes that Git-Zen reports on the ticket, when Upon change to issue property is on:

• Closed or reopened
• Assigned or unassigned
• Milestone set or removed
• Transferred to another repository
• Deleted

Label changes update the labels in the sidebar. They do not add a ticket comment.

When the issue closes, Git-Zen can also add tags to the ticket and solve it. See Zendesk tags and Closed ticket updates.

Events Git-Zen ignores

• Pull requests. Git-Zen does not sync pull request activity. The webhook that Git-Zen creates does not send this event. If an older webhook sends it, Git-Zen ignores it.
  • The sidebar does not list pull requests, and the issue picker does not include them. There is no setting to turn pull request sync on.
  • Git-Zen cannot create pull requests from Zendesk. It does not review, comment on, merge, or close them.
  • To connect a ticket to the code that fixes it, put a reference tag in the commit messages on the pull request branch. Or link the ticket to a GitHub issue, and use an issue-closing reference such as Fixes #1234 in the pull request. When the pull request closes the issue, Git-Zen reports the state change if Upon change to issue property is on.
  • To tell customers when a fix ships, use Release notifications. Git-Zen follows the pull requests listed in the release notes to the issues they fix.
• Project cards and Projects v2 items. Project board changes do not post to tickets. See Projects.
• Discussions, workflow runs, and other events. You do not need to turn them on.

Comment rules

• Add gz#skip to a GitHub comment to keep it out of Zendesk.
• If Upon issue comment is off, add your force keyword (for example gz#force) to send one comment anyway. See Ticket comments.
• If you edit a GitHub comment, Git-Zen copies the edited comment to the ticket as a new comment.
• Git-Zen ignores a GitHub comment that contains the text “Private comment from”, “Public comment from”, “Zendesk comment from”, or “Agent comment from”. Git-Zen uses these phrases to mark comments it sent from Zendesk. This prevents loops.

Plans

Issue, comment, and release events need the Full version. On Git-Zen Lite, Git-Zen uses push events only, for commit linking. See Plans and billing.