API キーと Webhook

すべて「設定」›「開発者」にあります。詳しいリファレンスは、このページ右上の「API ドキュメントを開く」をクリックしてください。

API キー

1. 1

   「キーを作成」をクリックして名前を付け、「読み取り専用」か「読み取りと書き込み」を選び、有効期限を選択します

2. 2

   キーをコピーして安全に保管します。キーが表示されるのは一度だけです

3. 3

   すべてのリクエストで、キーを Authorization ヘッダーに入れて送信します

キーはあなた自身として動作し、そのワークスペースであなたが閲覧・変更できる範囲にのみアクセスできます。キーの確認、名前の変更、無効化は「自分のキーを管理」から行います。オーナーと管理者はワークスペース内の全員のキーを確認でき、どのキーでも無効化できます。

Webhook（変更をほかのシステムに知らせる）

1. 1

   「送信先を追加」をクリックし、イベントを受け取る URL を入力して、タスクの作成、タスクのステータス変更、ノートの更新、新しいコメントなどのイベントを選択します

2. 2

   保存の前にテストリクエストが送信されます。送信先は 2xx のコードを返す必要があります

3. 3

   発行されたシークレットを保管し、すべてのリクエストの署名の検証に使います

送信先をクリックすると、配信履歴の確認、再送信、テストリクエストの送信ができます。配信の失敗が続くと送信先はオフになり、受信トレイに通知が届きます。ノートの内容と非公開ページが送信されることはありません。

受信 Webhook（ほかのシステムから作業を送り込む）

1. 1

   「URL を作成」をクリックし、呼び出す側のシステム名を付けます

2. 2

   URL を GitHub Actions、Zapier、フォームなどのシステムにコピーします。URL が表示されるのは一度だけです

3. 3

   そのシステムは URL を作成した人として、タスクの作成、ノートへの追記、コメントができます

URL をクリックすると、届いたリクエスト、成功したかどうか、送信元を確認できます。URL が漏れた場合は「新しい URL を作成」をクリックすると、古い URL はすぐに使えなくなります。