--- title: 【コンテンツのWebhook連携】GitHub Actionsの設定方法について description: microCMSではコンテンツの状態やAPI変更時にWebhookを発行し、外部のシステムと連携することができます。 このヘルプでは、コンテンツのWebhook連携におけるGitHub Actionsの設定方法について解説します。Webhook機能の詳細につきましては、microCMSドキュメント「コンテンツのWebhookを設定」をご覧ください。 GitHub Actionsと連携する際には、G --- [コンテンツまでスキップ](https://help.microcms.io/ja/knowledge/webhook-github-actions-settings#main-content) [![logo.png\]](https://help.microcms.io/hs-fs/hubfs/logo.png?width=150&height=34&name=logo.png)](https://microcms.io/) メインナビゲーションを開く メインナビゲーションを閉じる キーワードから探す - 検索フィールドが空なので、候補はありません。 1. [ヘルプ](https://help.microcms.io/ja/knowledge?hsLang=ja) 2. [機能](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja) 3. [Webhook](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#webhook) # 【コンテンツのWebhook連携】GitHub Actionsの設定方法について microCMSではコンテンツの状態やAPI変更時にWebhookを発行し、外部のシステムと連携することができます。 このヘルプでは、コンテンツのWebhook連携におけるGitHub Actionsの設定方法について解説します。Webhook機能の詳細につきましては、microCMSドキュメント「[コンテンツのWebhookを設定](https://document.microcms.io/manual/webhook-setting)」をご覧ください。 --- GitHub Actionsと連携する際には、GitHub側での設定とmicroCMS側での設定のそれぞれが必要となります。 ### 1. GitHub側での設定 #### （事前準備）ワークフローファイルを作成する 以下のドキュメントなどを参考に、GitHub Actionsのワークフローファイル（yaml形式）を作成してください。 ▼ワークフローファイルのイメージ ``` // バージョン等の情報が古くなっている可能性もありますので、// 最新情報は公式ドキュメントを参照ください。name: Deployon: repository_dispatch: types: [update]jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: 18 - run: npm install - run: npm run build - run: npm run deploy ``` 参考: [GitHub Actions のクイックスタート](https://docs.github.com/ja/actions/quickstart) microCMSと連携するために、ワークフローファイル内で "repository\_dispatch" のイベントを定義する必要があります。ここで指定したアクティビティの種類を説明する "event\_type" の値は、microCMS側のWebhookの設定時に必要なので控えておいてください。 repository\_dispatchの詳細は[GitHubのドキュメント](https://docs.github.com/ja/actions/using-workflows/events-that-trigger-workflows#repository_dispatch)をご欄ください。 #### トークンを作成する 次に、GitHub側で認証に必要なトークンを発行します。以下、手順を示します。 1\. GitHubのユーザー設定ページ（[https://github.com/settings/profile](https://github.com/settings/profile)）にアクセスします。 2.  ユーザー設定ページにて、左カラムの最下部にある「Developer settings」（[https://github.com/settings/apps](https://github.com/settings/apps)）にアクセスします。 2023年末現在、GitHubで作成できる個人用のアクセストークンは2種類あり、いずれも利用可能です。以下にて、それぞれのトークンの発行方法をご説明します。   **■ Fine-grained tokens（Beta）の場合** 3\. 左カラムから「Personal access tokens」のメニューを押下し、Fine-grained tokensを押下します。 4\. トークン一覧画面にて「Generate new token」ボタンを押下します。 ![CleanShot 2023-11-21 at 17.53.01@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2017.53.01@2x.png?width=688&height=177&name=CleanShot%202023-11-21%20at%2017.53.01@2x.png) 5\. 「New fine-grained personal access token」の画面で、以下の情報を入力します。 ![CleanShot 2023-11-21 at 18.40.42](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.40.42.png?width=688&height=632&name=CleanShot%202023-11-21%20at%2018.40.42.png) - **Token name**（必須）: 任意の名前を入力してください。 - **Expiration**（必須）: 任意の有効期限を選択してください。 - **Description**: 任意の説明文を入力してください。 - **Resource owner**: 連携したいリポジトリのオーナーを選択してください。 6\. 次に、「Repository access」セクションへ進み、「**Only select repositories**」を選択します。ここで連携したいリポジトリを選択してください。 ![CleanShot 2023-11-22 at 10.15.27](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-22%20at%2010.15.27.png?width=688&height=198&name=CleanShot%202023-11-22%20at%2010.15.27.png) 7\. 次に、「Permissions」セクションへ進み、「**Repository permissions**」のメニューを展開します。ここで、**「Contents」の権限に Read and write を付与**します。なお、「Account permissions」の設定はデフォルトのままとします。 ![CleanShot 2023-11-22 at 10.19.06](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-22%20at%2010.19.06.png?width=688&height=198&name=CleanShot%202023-11-22%20at%2010.19.06.png) 8.ページ下部の「Generate token」ボタンを押下します。 9\. トークンの一覧画面に戻り、作成したばかりのトークンが表示されているので、コピーして保存しておきます。トークンの作成はここで終了です。 ![CleanShot 2023-11-21 at 18.07.05@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.07.05@2x.png?width=688&height=278&name=CleanShot%202023-11-21%20at%2018.07.05@2x.png)   **■ Tokens（classic）の場合** 3\. 左カラムから「Personal access tokens」のメニューを押下し、Tokens（classic）を押下します。 4\. トークン一覧画面にて「Generate new token」ボタンを押下します。 ![CleanShot 2023-11-21 at 18.08.44@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.08.44@2x.png?width=688&height=212&name=CleanShot%202023-11-21%20at%2018.08.44@2x.png) 5\. 「New personal access token（classic）」の画面で、以下の情報を入力します。 ![CleanShot 2023-11-21 at 18.42.29](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.42.29.png?width=688&height=443&name=CleanShot%202023-11-21%20at%2018.42.29.png) - **Note**（必須）: 任意の説明を入力してください。 - **Expiration**（必須）: 任意の有効期限を選択してください。 6\. 次に、「Select scopes」セクションへ進み、「repo」にチェックをいれます。 ![CleanShot 2023-11-21 at 18.12.01@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.12.01@2x.png?width=688&height=161&name=CleanShot%202023-11-21%20at%2018.12.01@2x.png) 7.ページ下部の「Generate token」ボタンを押下します。 8\. トークンの一覧画面に戻り、作成したばかりのトークンが表示されているので、コピーして保存しておきます。トークンの作成はここで終了です。 ![CleanShot 2023-11-21 at 18.13.09@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-21%20at%2018.13.09@2x.png?width=688&height=317&name=CleanShot%202023-11-21%20at%2018.13.09@2x.png) ### 2. microCMS側での設定 次に、microCMS側での設定方法について、手順を示します。 1\. Webhookの設定をしたいAPIの「API設定」\>「Webhook」画面にアクセスし、「+ 追加」ボタンを押下します。 ![CleanShot 2023-11-22 at 10.23.32@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-22%20at%2010.23.32@2x.png?width=688&height=173&name=CleanShot%202023-11-22%20at%2010.23.32@2x.png) 2\. 次に、Webhook通知を行いたいサービスの選択画面が表示されるので、**GitHub Actions**を選択します。 3\. GitHub Actionsの設定画面内の「基本設定」セクションにて、以下のように入力します。 ![CleanShot 2023-11-22 at 11.13.12@2x](https://help.microcms.io/hs-fs/hubfs/CleanShot%202023-11-22%20at%2011.13.12@2x.png?width=688&height=460&name=CleanShot%202023-11-22%20at%2011.13.12@2x.png) - **Webhookの識別名** - **GitHubトークン**（必須）: **ここで、GitHub側で取得したアクセストークンを入力してください。** - リポジトリのユーザー名（必須） - リポジトリ名（必須） - トリガーイベント名（必須）: **ワークフローファイル内の repository\_dispatch 欄で定義した event\_types の値を入力してください。** 4\. 次に「通知タイミングの設定」セクションにて、任意の通知タイミングを選択してください。 5\. 最後に「設定する」を押下し、設定は完了です。 - [アカウント](https://help.microcms.io/ja/knowledge/%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88?hsLang=ja#main-content) - [ログイン](https://help.microcms.io/ja/knowledge/%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88?hsLang=ja#%E3%83%AD%E3%82%B0%E3%82%A4%E3%83%B3) - [登録／変更／削除](https://help.microcms.io/ja/knowledge/%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88?hsLang=ja#%E7%99%BB%E9%8C%B2%E5%A4%89%E6%9B%B4%E5%89%8A%E9%99%A4) - [その他](https://help.microcms.io/ja/knowledge/%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88?hsLang=ja#%E3%81%9D%E3%81%AE%E4%BB%96) - [機能](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#main-content) - [コンテンツ](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84) - [リッチエディタ](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%83%AA%E3%83%83%E3%83%81%E3%82%A8%E3%83%87%E3%82%A3%E3%82%BF) - [コンテンツAPI（GET）](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84apiget) - [コンテンツAPI（WRITE）](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84apiwrite) - [マネジメントAPI](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%83%9E%E3%83%8D%E3%82%B8%E3%83%A1%E3%83%B3%E3%83%88api) - [Webhook](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#webhook) - [インポート / エクスポート](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88-%E3%82%A8%E3%82%AF%E3%82%B9%E3%83%9D%E3%83%BC%E3%83%88) - [API設定](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#api%E8%A8%AD%E5%AE%9A) - [レビュー](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC) - [メディア（画像/ファイル）](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%83%A1%E3%83%87%E3%82%A3%E3%82%A2%E7%94%BB%E5%83%8F-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB) - [メンバー](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%83%A1%E3%83%B3%E3%83%90%E3%83%BC) - [権限](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E6%A8%A9%E9%99%90) - [複数環境](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E8%A4%87%E6%95%B0%E7%92%B0%E5%A2%83) - [セキュリティ](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%82%BB%E3%82%AD%E3%83%A5%E3%83%AA%E3%83%86%E3%82%A3) - [その他](https://help.microcms.io/ja/knowledge/%E6%A9%9F%E8%83%BD?hsLang=ja#%E3%81%9D%E3%81%AE%E4%BB%96) - [実装（全般）](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#main-content) - [トラブルシューティング](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#%E3%83%88%E3%83%A9%E3%83%96%E3%83%AB%E3%82%B7%E3%83%A5%E3%83%BC%E3%83%86%E3%82%A3%E3%83%B3%E3%82%B0) - [ユースケース別の実装方法](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#%E3%83%A6%E3%83%BC%E3%82%B9%E3%82%B1%E3%83%BC%E3%82%B9%E5%88%A5%E3%81%AE%E5%AE%9F%E8%A3%85%E6%96%B9%E6%B3%95) - [API](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#api) - [Webhook](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#webhook) - [インフラ](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E5%85%A8%E8%88%AC?hsLang=ja#%E3%82%A4%E3%83%B3%E3%83%95%E3%83%A9) - [実装（言語／フレームワーク）](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E8%A8%80%E8%AA%9E%E3%83%95%E3%83%AC%E3%83%BC%E3%83%A0%E3%83%AF%E3%83%BC%E3%82%AF?hsLang=ja#main-content) - [JavaScript](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E8%A8%80%E8%AA%9E%E3%83%95%E3%83%AC%E3%83%BC%E3%83%A0%E3%83%AF%E3%83%BC%E3%82%AF?hsLang=ja#javascript) - [Next.js](https://help.microcms.io/ja/knowledge/%E5%AE%9F%E8%A3%85%E8%A8%80%E8%AA%9E%E3%83%95%E3%83%AC%E3%83%BC%E3%83%A0%E3%83%AF%E3%83%BC%E3%82%AF?hsLang=ja#next-js) - [お支払い](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#main-content) - [従量課金](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#%E5%BE%93%E9%87%8F%E8%AA%B2%E9%87%91) - [プラン変更](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#%E3%83%97%E3%83%A9%E3%83%B3%E5%A4%89%E6%9B%B4) - [解約](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#%E8%A7%A3%E7%B4%84) - [請求書](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#%E8%AB%8B%E6%B1%82%E6%9B%B8) - [支払いサイクル](https://help.microcms.io/ja/knowledge/%E3%81%8A%E6%94%AF%E6%89%95%E3%81%84?hsLang=ja#%E6%94%AF%E6%89%95%E3%81%84%E3%82%B5%E3%82%A4%E3%82%AF%E3%83%AB) - [ご契約](https://help.microcms.io/ja/knowledge/%E3%81%94%E5%A5%91%E7%B4%84?hsLang=ja#main-content) - [Hobbyプラン](https://help.microcms.io/ja/knowledge/%E3%81%94%E5%A5%91%E7%B4%84?hsLang=ja#hobby%E3%83%97%E3%83%A9%E3%83%B3) - [Enterpriseプラン](https://help.microcms.io/ja/knowledge/%E3%81%94%E5%A5%91%E7%B4%84?hsLang=ja#enterprise%E3%83%97%E3%83%A9%E3%83%B3) - [セキュリティ](https://help.microcms.io/ja/knowledge/%E3%82%BB%E3%82%AD%E3%83%A5%E3%83%AA%E3%83%86%E3%82%A3?hsLang=ja#main-content) - [シングルサインオン](https://help.microcms.io/ja/knowledge/%E3%82%BB%E3%82%AD%E3%83%A5%E3%83%AA%E3%83%86%E3%82%A3?hsLang=ja#%E3%82%B7%E3%83%B3%E3%82%B0%E3%83%AB%E3%82%B5%E3%82%A4%E3%83%B3%E3%82%AA%E3%83%B3) - [既知の不具合](https://help.microcms.io/ja/knowledge/%E6%97%A2%E7%9F%A5%E3%81%AE%E4%B8%8D%E5%85%B7%E5%90%88?hsLang=ja#main-content) - [旧リッチエディタ](https://help.microcms.io/ja/knowledge/%E6%97%A2%E7%9F%A5%E3%81%AE%E4%B8%8D%E5%85%B7%E5%90%88?hsLang=ja#%E6%97%A7%E3%83%AA%E3%83%83%E3%83%81%E3%82%A8%E3%83%87%E3%82%A3%E3%82%BF) - [その他](https://help.microcms.io/ja/knowledge/%E3%81%9D%E3%81%AE%E4%BB%96?hsLang=ja) 株式会社microCMS