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

# 購読イベント一覧 (v3)

> 購読可能なイベントをサービスごとに取得します。通常キーとテストキーで同じ一覧を返します。eventTypesの値をsubscribedEventsに指定してください。



## OpenAPI

````yaml ja/api-reference/openapi.yaml GET /api/v3/orders/webhooks/event-types
openapi: 3.0.0
info:
  title: ContentCare API
  version: 2.0.0
  description: >-
    ContentCare API は、デジタルコンテンツ保護のための4つのコアサービスを提供します:

    - **Anti-AI**: 画像をAI学習から保護

    - **Watermark Embed**: 画像に不可視のデジタル watermark を埋め込み

    - **Watermark Extract**: 画像から watermark を抽出・検証

    - **AI Detection**: 画像がAI生成かどうかを検知

    - **テストAPIキー**: `sk_test_`
    プレフィックスのキーは同じBearer認証を使用し、実際の処理サービスの実行やクレジットの消費なしに注文ライフサイクルを検証できます。テストアップロードの内容は破棄され、結果ファイルは作成されません
  contact:
    name: ContentCare サポート
    email: support@contentcare.ai
  license:
    name: Proprietary
    url: https://docs.contentcare.ai/legal/terms
servers:
  - url: https://api.bizmori.com
    description: 本番環境
security: []
tags:
  - name: Anti-AI
    description: Anti-AI画像保護の注文
  - name: Watermark Embed
    description: watermark 埋め込みの注文
  - name: Watermark Extract
    description: watermark 抽出の注文
  - name: AI Detection
    description: AI生成画像検知の注文
  - name: Orders
    description: 注文の照会と管理
  - name: Webhooks
    description: Webhookの設定とイベント
  - name: Reports
    description: watermark 抽出・AI Detection 注文の PDF 分析レポート
paths:
  /api/v3/orders/webhooks/event-types:
    get:
      tags:
        - Webhooks
      summary: 購読イベント一覧 (v3)
      description: >-
        購読可能なイベントをサービスごとに取得します。通常キーとテストキーで同じ一覧を返します。eventTypesの値をsubscribedEventsに指定してください。
      operationId: getWebhookEventTypesV3
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookEventCatalog'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - BearerAuth: []
components:
  schemas:
    WebhookEventCatalog:
      type: object
      required:
        - groups
        - eventTypes
        - legacyDefaultEventTypes
      properties:
        groups:
          type: array
          items:
            type: object
            required:
              - service
              - events
            properties:
              service:
                type: string
                example: antiAi
              events:
                type: array
                items:
                  type: object
                  required:
                    - type
                    - outcome
                  properties:
                    type:
                      type: string
                      example: order.antiAi.completed
                    outcome:
                      type: string
                      enum:
                        - completed
                        - failed
        eventTypes:
          type: array
          items:
            type: string
          example:
            - order.antiAi.completed
            - order.antiAi.failed
            - order.watermarkEmbed.completed
            - order.watermarkEmbed.failed
            - order.watermarkExtract.completed
            - order.watermarkExtract.failed
            - order.aiDetection.completed
            - order.aiDetection.failed
        legacyDefaultEventTypes:
          type: array
          items:
            type: string
          example:
            - order.antiAi.completed
            - order.antiAi.failed
            - order.watermarkEmbed.completed
            - order.watermarkEmbed.failed
            - order.watermarkExtract.completed
            - order.watermarkExtract.failed
            - order.aiDetection.completed
            - order.aiDetection.failed
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: エラーコード
  responses:
    Unauthorized:
      description: 認証失敗
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: AUTH_NOT_AUTHENTICATED
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        外部クライアントアクセス用のBearer APIキー。本番キーは `sk_` プレフィックスを使用し、テストキーは `sk_test_`
        プレフィックスを使用して、処理やクレジット消費なしに注文ライフサイクルを検証します。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.