--- title: "GitCafe" description: "Use GitCafe: repositories, issues, pull requests, reviews, checks, files and signed webhooks." canonical_url: "https://forgeslink-qeddw7z43-poetry.vercel.app/providers/gitcafe" --- # GitCafe > Use GitCafe: repositories, issues, pull requests, reviews, checks, files and signed webhooks. The GitCafe provider works with [GitCafe](https://git.cafe), a forge with an API of its own rather than one modelled on GitHub's. It can read repositories, labels, milestones, issues, pull requests, comments, reactions, reviews, checks, files, branches, tags and commits. It can also create and change issues and pull requests, comment, react, review and merge, report commit statuses, and manage webhooks and verify their deliveries. The [OpenAPI specification](https://git.cafe/api/openapi/json) of the API documents its endpoints.

Detail	Value
Import	`forges/gitcafe`
Factories	`gitcafe()`
Auth	`token` , `anonymous`

The GitCafe provider is experimental, because GitCafe is in public beta and its API can still change. To learn what that means, see [Capabilities](https://forgeslink-qeddw7z43-poetry.vercel.app/concepts/capabilities). ## Authentication The provider accepts a personal access token, which you create under **Settings > Tokens**. These tokens start with `gct_`, always expire, and carry only the permissions you choose for them: a token that reads issues can't read pull requests unless you grant that too. The provider sends the token in an `Authorization: Bearer ` header: ```ts import { gitcafe } from 'forges/gitcafe' const forge = gitcafe({ auth: { type: 'token', token: process.env.GITCAFE_TOKEN! }, }) ``` If you leave out `auth`, the provider reads public repositories anonymously. GitCafe counts anonymous requests per network address, 1,200 an hour. ## Instance The `baseUrl` defaults to `https://git.cafe`, and the provider appends `/api` itself. ## Issues and pull requests `threads.get()` reads both issues and pull requests, and `threads.list()` lists both kinds by default, issues first. To select only one, set `kind: 'issue'` or `kind: 'pull_request'`. A GitCafe issue has one of six states. `triage`, `backlog`, `unstarted` and `started` are `open`, and `completed` and `canceled` are `closed`. `Thread.stateRaw` has the forge's own state. `threads.close()` closes an issue as `completed`, or as `canceled` with the reason `not_planned` or `duplicate`. The listing of pull requests includes their labels, assignees and reviewers, but a single pull request doesn't. `threads.get()` therefore reads those three beside the pull request, and its milestone when it has one, which makes four or five requests. GitCafe filters issues by the ids of labels and accounts, and doesn't filter pull requests by them at all. The provider applies `labels`, `author` and `assignee` to each page after reading it instead, so a filtered page can hold fewer threads than `perPage`, and has no `total`. `threads.create()` opens both kinds. `labels` must name labels that already exist. A pull request needs `head` and `base`, and opens ready for review, so `threads.create()` rejects `draft`. To open one from a fork, pass `head` as `owner:branch`. ## Writes and versions GitCafe refuses a write that doesn't name the version of what it changes, so that two edits can't overwrite each other. The provider reads the thread or the comment first and sends its version with the write, which makes each write two requests. When someone else changes the thread in between, the forge answers `409` and the call rejects. GitCafe takes ids where other forges take names. `threads.setLabels()` looks up the labels of the repository, and `threads.setAssignees()` and `threads.requestReview()` look up each login, unless you pass an `Actor`. ## Reactions GitCafe stores a reaction as an emoji. The provider sends the emoji that GitHub draws for each `ReactionContent`, such as 🚀 for `rocket`, and reads those emoji back under the same names. Any other emoji is `content: 'other'`, with the emoji itself in `contentRaw`. ## Reviews `threads.reviews()` and `threads.getReview()` read the reviews of a pull request, with their inline comments. `threads.createReview()` submits a review with a verdict and a body. GitCafe attaches inline comments through a review draft, which the provider doesn't write yet, so `threads.createReview()` rejects `comments` and a review without an `event`. A review thread's id is the id of its first comment, which is what `threads.resolveReviewThread()` and `threads.unresolveReviewThread()` take. An account can't review its own pull request, so `threads.requestReview()` rejects the author. ## Merging GitCafe merges in the background. `threads.merge()` usually resolves with `status: 'queued'`, and the pull request reads as `merged` a moment later. The methods are `merge`, `squash`, `rebase` and `fast_forward_only`. Without one, the pull request must allow exactly one. The merge commit has the forge's own message, so `title` and `message` are ignored. ## Checks and CI `checks.list()` and `threads.checks()` read the checks of a commit, which include the commit statuses reported for it. `checks.report()` writes a commit status, whose state is `pending`, `success` or `failure`. `ci.runs()` lists the workflow runs of a repository. GitCafe filters runs by whether they have finished, so the provider applies `state` to each page after reading it, and a filtered page can hold fewer runs than `perPage`. GitCafe runs the workflows in `.github/workflows`, but its hosted runners are in beta and not yet open to every repository, so the provider doesn't read a single run or its jobs yet. ## Files and revisions GitCafe addresses a revision by a full ref name, such as `refs/heads/main`, or by a full sha. When you pass a bare name, the provider tries it as a branch first and as a tag second. Pass the full ref name to save the second request for a tag. `contents.tree()` lists one directory at a time, so `recursive` adds a `recursive_unsupported` warning to the page. `contents.compare()` isn't available, because the comparison has the changed files but not the commits. ## Thread events The API has no timeline, so the provider can't list the events of a thread directly. Instead, `threads.events()` is `'emulated'` from the comment listing, which means it returns comment events only. ## Webhooks `webhooks.create()` registers a hook on a repository, or on an organization when you pass a namespace ref. A repository or an organization can have ten. GitCafe names its events `.`, such as `issue.created` or `pull.merged`, and [`nativeEvents`](https://forgeslink-qeddw7z43-poetry.vercel.app/guides/webhooks) takes those names as they are. GitCafe signs each delivery with HMAC-SHA256 over the timestamp in `X-GitCafe-Timestamp`, a `.` and the body. `webhooks.ingest()` checks that signature against `webhookSecret`, and rejects a delivery whose timestamp is more than five minutes from now. A delivery names accounts by id alone, so its events have no `actor`. The id is in `payload.actor.id`. A push becomes one event for each ref that it moved. ## Releases and notifications GitCafe has no releases and no notifications, so those capabilities are `'not_applicable'`. ## Capabilities

Capability	Support	Without credentials
`experimental`	✅	✅
`sources.stream`	❌	❌
`repos.get`	✅	✅
`users.get`	✅	✅
`users.me`	✅	❌
`users.sponsorable`	∅	∅
`users.sponsorableMany`	∅	∅
`users.events`	❌	❌
`users.block`	❌	❌
`repos.list`	✅	❌
`repos.byOwner`	✅	✅
`repos.labels`	✅	✅
`repos.createLabel`	unverified	❌
`repos.milestones`	✅	✅
`repos.issueTypes`	∅	∅
`repos.collaborators`	✅	❌
`repos.contributors`	❌	❌
`repos.contributorStats`	❌	❌
`repos.templates`	❌	❌
`repos.permissionFor`	❌	❌
`repos.branchRules`	❌	❌
`repos.addCollaborator`	❌	❌
`repos.assignableUsers`	✅	❌
`repos.reviewerCandidates`	❌	❌
`repos.events`	❌	❌
`orgs.teams`	❌	❌
`orgs.teamMembers`	❌	❌
`orgs.block`	❌	❌
`threads.get`	issue, PR	issue, PR
`threads.list`	issue, PR	issue, PR
`threads.getMany`	✅	✅
`threads.closingIssues`	❌	❌
`threads.closingPullRequests`	❌	❌
`threads.events`	issue (emulated), PR (emulated)	issue (emulated), PR (emulated)
`threads.comments`	issue, PR	issue, PR
`threads.getComment`	issue (emulated), PR (emulated)	issue (emulated), PR (emulated)
`threads.createComment`	issue (unverified), PR (unverified)	❌
`threads.updateComment`	issue (unverified), PR (unverified)	❌
`threads.deleteComment`	issue (unverified), PR (unverified)	❌
`threads.hideComment`	❌	❌
`threads.reactions`	issue, PR	issue, PR
`threads.react`	issue (unverified), PR (unverified)	❌
`threads.create`	issue (unverified), PR (unverified)	❌
`threads.update`	issue (unverified), PR (unverified)	❌
`threads.close`	issue (unverified), PR (unverified)	❌
`threads.reopen`	issue (unverified), PR (unverified)	❌
`threads.lock`	issue (unverified), PR (unverified)	❌
`threads.setLabels`	issue (unverified), PR (unverified)	❌
`threads.addLabels`	❌	❌
`threads.removeLabels`	❌	❌
`threads.setMilestone`	issue (unverified), PR (unverified)	❌
`threads.setIssueType`	∅	∅
`threads.setAssignees`	issue (unverified), PR (unverified)	❌
`threads.requestReview`	PR (unverified)	❌
`threads.merge`	unverified	❌
`threads.updateBranch`	❌	❌
`threads.transfer`	∅	∅
`threads.markDuplicate`	∅	∅
`threads.subscription`	❌	❌
`threads.subscribe`	❌	❌
`threads.checks`	PR	PR
`threads.files`	✅	✅
`threads.commits`	✅	✅
`threads.reviews`	✅	✅
`threads.getReview`	✅	✅
`threads.createReview`	unverified	❌
`threads.submitReview`	❌	❌
`threads.approve`	unverified	❌
`threads.replyToReviewComment`	unverified	❌
`threads.reviewThreads`	✅	✅
`threads.resolveReviewThread`	unverified	❌
`notifications.list`	∅	∅
`notifications.markRead`	∅	∅
`notifications.markDone`	∅	∅
`notifications.unsubscribe`	∅	∅
`notifications.markAllRead`	∅	∅
`notifications.markAllDone`	∅	∅
`notifications.unreadCount`	❌	❌
`installations.list`	❌	❌
`checks.list`	✅	✅
`checks.get`	❌	❌
`checks.report`	unverified	❌
`checks.rerun`	❌	❌
`ci.runs`	✅	✅
`ci.getRun`	❌	❌
`ci.jobs`	❌	❌
`ci.getJob`	❌	❌
`ci.log`	❌	❌
`ci.rerunFailed`	❌	❌
`contents.getFile`	✅	✅
`contents.tree`	✅	✅
`contents.branches`	✅	✅
`contents.tags`	✅	✅
`contents.resolveRef`	✅	✅
`contents.compare`	❌	❌
`contents.commitFiles`	❌	❌
`commits.list`	✅	✅
`commits.get`	✅	✅
`commits.comments`	❌	❌
`commits.getComment`	❌	❌
`commits.createComment`	❌	❌
`commits.updateComment`	❌	❌
`commits.deleteComment`	❌	❌
`commits.hideComment`	❌	❌
`releases.list`	∅	∅
`releases.get`	∅	∅
`releases.latest`	∅	∅
`releases.getByTag`	∅	∅
`releases.downloadAsset`	∅	∅
`releases.create`	∅	∅
`releases.update`	∅	∅
`webhooks.ingest`	✅	✅
`webhooks.list`	✅	❌
`webhooks.create`	unverified	❌
`webhooks.update`	unverified	❌
`webhooks.delete`	unverified	❌
`webhooks.rotateSecret`	❌	❌
`webhooks.deliveries`	✅	❌
`webhooks.redeliver`	❌	❌
`search.threads`	❌	❌
`search.repos`	❌	❌
`search.commits`	❌	❌
`search.code`	❌	❌
`securityAlerts.list`	❌	❌
`eventKinds`	native	native
`authKinds`	`token` , `anonymous`	`token` , `anonymous`
`limits`	unknown	unknown

## Sitemap See the full [sitemap](https://forgeslink-qeddw7z43-poetry.vercel.app/sitemap.md) for all pages.