在 FastAPI 中，透過 OpenAPI，你可以定義這些 webhook 的名稱、你的應用將發送的 HTTP 操作類型（例如 `POST`、`PUT` 等），以及你的應用要發送的請求主體。

這能讓你的使用者更容易實作他們的 API 以接收你的 webhook 請求，甚至可能自動產生部分他們自己的 API 程式碼。

/// info

Webhook 功能自 OpenAPI 3.1.0 起提供，FastAPI `0.99.0` 以上版本支援。

///

## 含有 webhook 的應用 { #an-app-with-webhooks }

建立 FastAPI 應用時，會有一個 `webhooks` 屬性可用來定義 webhook，方式與定義路徑操作相同，例如使用 `@app.webhooks.post()`。

Webhook は OpenAPI 3.1.0 以上で利用可能で、FastAPI `0.99.0` 以上が対応しています。

///

## Webhook を持つアプリ { #an-app-with-webhooks }

**FastAPI** アプリケーションを作成すると、`webhooks` という属性があり、ここで *path operations* と同様に（例: `@app.webhooks.post()`）*webhook* を定義できます。

{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *}

定義した webhook は **OpenAPI** スキーマおよび自動生成される **ドキュメント UI** に反映されます。

/// info | 情報

    steps:
      - name: Send Slack notification about new RCs for manual testing
        id: slack
        uses: slackapi/slack-github-action@v3.0.1
        with:
          webhook: ${{ secrets.IDE_EXPERIENCE_TEAM_SLACK_WEBHOOK_URL }}
          webhook-type: incoming-webhook
          payload: |
            text: "<https://github.com/gradle/gradle/${{ github.event.ref }}|[gradle/gradle#${{ github.event.ref }}]> has been pushed"
            blocks:

/// info

Webhooks are available in OpenAPI 3.1.0 and above, supported by FastAPI `0.99.0` and above.

///

## An app with webhooks { #an-app-with-webhooks }

                    )
                if path_definitions:
                    definitions.update(path_definitions)
    for webhook in webhooks or []:
        if isinstance(webhook, routing.APIRoute):
            result = get_openapi_path(
                route=webhook,
                operation_ids=operation_ids,
                model_name_map=model_name_map,
                field_mapping=field_mapping,

    /** Notification message displayed on the advanced search page. */
    @Size(max = 3000)
    public String notificationAdvanceSearch;

    /** Slack webhook URLs for notifications. */
    @Size(max = 10000)
    public String slackWebhookUrls;

    /** Google Chat webhook URLs for notifications. */
    @Size(max = 10000)
    public String googleChatWebhookUrls;

    /** Property key for Slack webhook URLs configuration. */
    public static final String SLACK_WEBHOOK_URLS_PROPERTY = "slack.webhook.urls";

    /** Property key for Google Chat webhook URLs configuration. */
    public static final String GOOGLE_CHAT_WEBHOOK_URLS_PROPERTY = "google.chat.webhook.urls";

    /** Property key for log notification enabled configuration. */

/// info | 정보

Webhooks는 OpenAPI 3.1.0 이상에서 사용할 수 있으며, FastAPI `0.99.0` 이상에서 지원됩니다.

///

## webhooks가 있는 앱 { #an-app-with-webhooks }

**FastAPI** 애플리케이션을 만들면, *경로 처리*를 정의하는 것과 같은 방식으로(예: `@app.webhooks.post()`), *webhooks*를 정의하는 데 사용할 수 있는 `webhooks` 속성이 있습니다.

{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *}

여러분이 정의한 webhook은 **OpenAPI** 스키마와 자동 **docs UI**에 포함됩니다.

/// info | 정보

labels.search_file_proxy_enabled=Search File Proxy
labels.search_use_browser_locale=Use Browser Locale
labels.sso_type=SSO Type
labels.crawling_user_agent=User Agent
labels.slack_webhook_urls=Slack Webhook URLs
labels.google_chat_webhook_urls=Google Chat Webhook URLs
labels.log_notification_enabled=Log Notification
labels.log_notification_level=Log Notification Level
labels.notification_advance_search=Advanced Search Page

///

## Webhook'ları olan bir uygulama { #an-app-with-webhooks }

Bir **FastAPI** uygulaması oluşturduğunuzda, *webhook*'ları tanımlamak için kullanabileceğiniz bir `webhooks` attribute'u vardır; *path operation* tanımlar gibi, örneğin `@app.webhooks.post()` ile.

{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *}