> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Webhook の設定

> Square Cloud を GitHub の webhook と連携します。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  アカウントの API キーです。これは[アカウント設定](https://squarecloud.app/ja/account/security)で確認できます。
</ParamField>

### パラメータ

<ParamField path="app_id" type="string" placeholder="Application ID" required>
  アプリケーションの ID。アプリケーションのダッシュボードの URL で確認できます。
</ParamField>

<ParamField body="access_token" type="string" placeholder="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" required>
  GitHub リポジトリのアクセストークン。[GitHub Tokens Classic](https://github.com/settings/tokens/new) で確認できます。
</ParamField>

### レスポンス

<ResponseField name="status" type="string">
  呼び出しが成功したかどうかを示します。成功した場合は `success`、失敗した場合は `error` です。
</ResponseField>

<ResponseField name="response" type="object">
  レスポンスの内容。

  <Expandable title="オブジェクトを表示">
    <ResponseField name="webhook" type="string">
      webhook の URL。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": {
          "webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
      }
  }
  ```
</ResponseExample>