---
title: "Dispatch a workflow"
method: POST
path: "/api/repos/{owner}/{repo}/actions/dispatch"
tags: ["Actions"]
---

# Dispatch a workflow

`POST /api/repos/{owner}/{repo}/actions/dispatch`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/actions/dispatch`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:contents:write`

GitCafe Actions only: captures a workflow_dispatch of one workflow file at the commit the branch or tag names now. Dispatch inputs are not supported; workflow defaults apply and workflows with required inputs without defaults cannot run through this endpoint. This does not dispatch workflows on GitHub, including for mirrored repositories; use GitHub workflow dispatch for those. Native GitCafe Actions must be enabled (otherwise ACTIONS_DISABLED, 409); enabling it does not enable GitHub dispatch. Replaying requestKey returns the same trigger; discovery then publishes the run if the workflow declares workflow_dispatch. Requires authenticated authority and enforces current resource policy.

## Path parameters

- `owner` string, required
- `repo` string, required

## Request body

- object: GitCafe Actions only; dispatch inputs are not supported. Workflow defaults apply. This request does not dispatch a workflow on GitHub.
  - `workflowPath` string, required
  - `ref` string, required
  - `requestKey` string, required

## Response `202`

Response for status 202

- object
  - `triggerId` string, required
  - `replayed` boolean, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)