Create a repository dispatch event

POST

/repos/{owner}/{repo}/dispatches

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

This input example shows how you can use the client_payload as a test to debug your workflow.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢204No Content

Response

このレスポンスにはボディがありません

🟠404Record Not Found

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

curl --location 'https://service1.exmaple.com/repos///dispatches' \
--header 'Content-Type: application/json' \
--data '{
    "event_type": "on-demand-test",
    "client_payload": {
        "unit": false,
        "integration": true
    }
}'

レスポンスExample

404 - 例 1

{
    "message": "string",
    "documentation_url": "string",
    "url": "string",
    "status": "string"
}

更新日時 2025-06-12 06:47:19

Get a deployment status

List environments