webhook list

Description

Webhook一覧を出力します。

Examples

基本的な使い方

以下のコマンドは、プロジェクトprj1のWebhook一覧をCSV形式で出力します。

$ annofabcli webhook list --project_id prj1 --format csv --output out.csv

CSV形式の場合、 headers はJSON文字列として出力します。 body は文字列としてそのまま出力します。

出力結果

CSV出力

$ annofabcli webhook list --project_id prj1 --format csv --output out.csv

JSON出力

$ annofabcli webhook list --project_id prj1 --format pretty_json --output out.json

out.json

[
    {
        "project_id": "prj1",
        "webhook_id": "webhook1",
        "webhook_status": "active",
        "event_type": "task-completed",
        "method": "POST",
        "url": "https://example.com/webhook",
        "headers": [
            {
                "name": "Content-Type",
                "value": "application/json"
            }
        ],
        "body": "{\"project_id\":\"{{PROJECT_ID}}\",\"task_id\":\"{{TASK_ID}}\"}",
        "created_datetime": "2026-01-23T03:02:56.478+09:00",
        "updated_datetime": "2026-01-23T03:02:56.478+09:00"
    },
    ...
]

Usage Details

Webhook一覧を出力します。

usage: annofabcli webhook list [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                               [--annofab_user_id ANNOFAB_USER_ID]
                               [--annofab_password ANNOFAB_PASSWORD]
                               [--annofab_pat ANNOFAB_PAT] [--logdir LOGDIR]
                               [--disable_log] [--debug] -p PROJECT_ID
                               [-f {csv,json,pretty_json}] [-o OUTPUT]

Named Arguments

-p, --project_id

対象のプロジェクトのproject_idを指定します。

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマットを指定します。

Default: 'csv'

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

global optional arguments

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。