Webhooks

Gitea 支持仓库事件的 Webhooks。 可以在仓库管理员的设置页面 /:username/:reponame/settings/hooks 中进行配置。 Webhooks 也可以在每个组织和整个系统级别进行配置。 所有事件推送都是 POST 请求。 当前支持的方法是

• Gitea (也可以是 GET 请求)
• Gogs
• Slack
• Discord
• 钉钉
• 电报
• Microsoft Teams
• 飞书
• 企业微信
• Packagist

事件信息

警告

自 Gitea 1.13.0 起，有效载荷中的 secret 字段已弃用，将在 1.14.0 中删除：https://github.com/go-gitea/gitea/issues/11755

以下是以 Gitea 发送到有效载荷 URL 的事件信息的示例

X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
X-GitHub-Event: push
X-Gogs-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
X-Gogs-Event: push
X-Gitea-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
X-Gitea-Event: push

{
  "secret": "3gEsCfjlV2ugRwgpU#w1*WaW*wa4NXgGmpCfkbG3",
  "ref": "refs/heads/develop",
  "before": "28e1879d029cb852e4844d9c718537df08844e03",
  "after": "bffeb74224043ba2feb48d137756c8a9331c449a",
  "compare_url": "https://127.0.0.1:3000/gitea/webhooks/compare/28e1879d029cb852e4844d9c718537df08844e03...bffeb74224043ba2feb48d137756c8a9331c449a",
  "commits": [
    {
      "id": "bffeb74224043ba2feb48d137756c8a9331c449a",
      "message": "Webhooks Yay!",
      "url": "https://127.0.0.1:3000/gitea/webhooks/commit/bffeb74224043ba2feb48d137756c8a9331c449a",
      "author": {
        "name": "Gitea",
        "email": "[email protected]",
        "username": "gitea"
      },
      "committer": {
        "name": "Gitea",
        "email": "[email protected]",
        "username": "gitea"
      },
      "timestamp": "2017-03-13T13:52:11-04:00"
    }
  ],
  "repository": {
    "id": 140,
    "owner": {
      "id": 1,
      "login": "gitea",
      "full_name": "Gitea",
      "email": "[email protected]",
      "avatar_url": "https://127.0.0.1:3000/avatars/1",
      "username": "gitea"
    },
    "name": "webhooks",
    "full_name": "gitea/webhooks",
    "description": "",
    "private": false,
    "fork": false,
    "html_url": "https://127.0.0.1:3000/gitea/webhooks",
    "ssh_url": "ssh://gitea@localhost:2222/gitea/webhooks.git",
    "clone_url": "https://127.0.0.1:3000/gitea/webhooks.git",
    "website": "",
    "stars_count": 0,
    "forks_count": 1,
    "watchers_count": 1,
    "open_issues_count": 7,
    "default_branch": "master",
    "created_at": "2017-02-26T04:29:06-05:00",
    "updated_at": "2017-03-13T13:51:58-04:00"
  },
  "pusher": {
    "id": 1,
    "login": "gitea",
    "full_name": "Gitea",
    "email": "[email protected]",
    "avatar_url": "https://127.0.0.1:3000/avatars/1",
    "username": "gitea"
  },
  "sender": {
    "id": 1,
    "login": "gitea",
    "full_name": "Gitea",
    "email": "[email protected]",
    "avatar_url": "https://127.0.0.1:3000/avatars/1",
    "username": "gitea"
  }
}

示例

这是一个使用 Webhooks 在向仓库推送请求时运行 php 脚本的示例。 在您的仓库设置中，在 Webhooks 下，设置一个 Gitea webhook，如下所示

• 目标 URL：http://mydomain.com/webhook.php
• HTTP 方法：POST
• POST 内容类型：application/json
• 密钥：123
• 触发条件：推送事件
• 激活：选中

现在在您的服务器上创建 php 文件 webhook.php

<?php

$secret_key = '123';

// check for POST request
if ($_SERVER['REQUEST_METHOD'] != 'POST') {
    error_log('FAILED - not POST - '. $_SERVER['REQUEST_METHOD']);
    exit();
}

// get content type
$content_type = isset($_SERVER['CONTENT_TYPE']) ? strtolower(trim($_SERVER['CONTENT_TYPE'])) : '';

if ($content_type != 'application/json') {
    error_log('FAILED - not application/json - '. $content_type);
    exit();
}

// get payload
$payload = trim(file_get_contents("php://input"));

if (empty($payload)) {
    error_log('FAILED - no payload');
    exit();
}

// get header signature
$header_signature = isset($_SERVER['HTTP_X_GITEA_SIGNATURE']) ? $_SERVER['HTTP_X_GITEA_SIGNATURE'] : '';

if (empty($header_signature)) {
    error_log('FAILED - header signature missing');
    exit();
}

// calculate payload signature
$payload_signature = hash_hmac('sha256', $payload, $secret_key, false);

// check payload signature against header signature
if ($header_signature !== $payload_signature) {
    error_log('FAILED - payload signature');
    exit();
}

// convert json to array
$decoded = json_decode($payload, true);

// check for json decode errors
if (json_last_error() !== JSON_ERROR_NONE) {
    error_log('FAILED - json decode - '. json_last_error());
    exit();
}

// success, do something

在 webhook 设置中有一个“测试传递”按钮，允许测试配置以及最近传递列表。

授权头

从 1.19 开始，Gitea hook 可以配置为向 webhook 目标发送 授权头。