Webhook一覧の取得

GET /api/v2/projects/:projectIdOrKey/webhooks

プロジェクトに登録されているWebhookの一覧を取得します。
Webhookを利用すると、プロジェクトで発生したイベントを指定したURLに通知できます。
対象のプロジェクトはプロジェクト一覧の取得から取得できます。

実行可能な権限

管理者
プロジェクト管理者

URL パラメーター

パラメーター名	型	内容
projectIdOrKey	string	以下のいずれかを指定します。 プロジェクトのID プロジェクトキー プロジェクトのIDとプロジェクトキーはプロジェクト一覧の取得から取得できます。

リクエストの例

curl --request GET \
--url "https://{{YOUR-DOMAIN}}/api/v2/projects/{{PROJECT_ID_OR_KEY}}/webhooks?apiKey=$API_KEY"

{{YOUR-DOMAIN}}には、対象のスペースのドメインを記入してください。ドメインは、以下のいずれかです。スペースIDが不明の場合は、スペースIDとは？を参照してください。

• https://[スペースID].backlog.com
• https://[スペースID].backlog.jp
• https://[スペースID].backlogtool.com

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8

レスポンスボディ

[
    {
        "id": 3,
        "name": "webhook",
        "description": "",
        "hookUrl": "http://nulab.test/",
        "allEvent": false,
        "activityTypeIds": [1, 2, 3, 4, 5],
        "createdUser": {
            "id": 1,
            "userId": "admin",
            "name": "admin",
            "roleType": 1,
            "lang": "ja",
            "nulabAccount": {
                "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
                "name": "admin",
                "uniqueId": "admin"
            },
            "mailAddress": "eguchi@nulab.example",
            "lastLoginTime": "2022-09-01T06:35:39Z"
        },
        "created": "2014-11-30T01:22:21Z",
        "updatedUser": {
            "id": 1,
            "userId": "admin",
            "name": "admin",
            "roleType": 1,
            "lang": "ja",
            "nulabAccount": {
                "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
                "name": "admin",
                "uniqueId": "admin"
            },
            "mailAddress": "eguchi@nulab.example",
            "lastLoginTime": "2022-09-01T06:35:39Z"
        },
        "updated": "2014-11-30T01:22:21Z"
    },
    // ...
]

エラーレスポンス

エラーレスポンスを参照してください。

制限事項

レート制限を参照してください