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

# Chatwoot webhook エンドポイント

> ChatwootからWebフックイベントを受信し、WhatsAppにメッセージを送信します。
このURLをChatwoot受信トレイのWebhook設定で設定します。

CHATWOOT_WEBHOOK_SECRET が設定されている場合、リクエストはそのシークレットを知っていることを
証明する必要があります。 推奨：API チャンネルに Webhook シークレットが設定されている場合に Chatwoot が送信する、
Chatwoot 独自の署名を使用します。`X-Chatwoot-Timestamp`（Unix 秒）と
`X-Chatwoot-Signature: sha256=<hex HMAC-SHA256 of "<timestamp>.<raw body>">` です。
タイムスタンプはサーバークロックのCHATWOOT_WEBHOOK_SIGNATURE_TOLERANCE (5m×
default) 内になければなりません。 次の形式も受け付けます：`X-Hub-Signature-256`
（生のリクエスト本文の HMAC-SHA256）、`X-Chatwoot-Webhook-Secret`
または `X-Gowa-Chatwoot-Secret` に指定したシークレット、あるいは `secret` クエリパラメーター（非推奨：
シークレットが URL やログに記録されるため）。

適用されるシークレットは、ペイロードのルーティング先デバイスのシークレットです。
そのデバイスの設定に `webhook_secret` がある場合はそれを使用します（この場合、
そのデバイスではグローバルシークレットは受け付けません）。それ以外の場合やデバイスを特定できない場合は、CHATWOOT_WEBHOOK_SECRET
を使用します。 許容時間内にすでに受け付けられた
（2xx を返した）Chatwoot 署名付きリクエストには、
200 を返し、処理は再実行しません。 
に他のステータスで答えられたものは記憶されないため、同一の
リクエストを再度送信することは処理されます。




## OpenAPI

````yaml /ja/openapi.yml post /chatwoot/webhook
openapi: 3.0.0
info:
  title: WhatsApp API マルチデバイス
  version: 9.7.0
  description: |
    この API は API 経由で whatsapp を送信するために使用されます。

    Web ダッシュボードは別のプロジェクトです (gowa-ui); サーバーは
    最新のリリースアセットをダウンロードし、`/`で動作します（または、
    APP_UI_ENABLED=falseの場合はJSONバナーを返します）。

    デバイススコープ:
    - すべてのデバイススコープの REST コールで `X-Device-Id` を送信します。
    - WebSocket: `/wsに接続しますか？device_id=<id> ` 。
    - WebSocket 認証（Basic Auth が有効な場合）: ブラウザーは WebSocket 接続で
      Authorization ヘッダーを設定できないため、クエリ文字列にも
      `&authorization=<base64(user:pass)>` を渡してください。 認証情報が URL に表示されるため、本番環境では
      TLS を使用してください。
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Whatsappサーバーへの初期接続
  - name: device
    description: マルチデバイスサポートのためのデバイス管理
  - name: user
    description: 情報の取得
  - name: send
    description: メッセージ (テキスト/イメージ/ファイル/ビデオ) を送信します。
  - name: message
    description: メッセージ操作 (revoke/react/update)
  - name: call
    description: 通話管理 (着信拒否)
  - name: chat
    description: チャットとメッセージ
  - name: group
    description: グループ設定
  - name: newsletter
    description: ニュースレターの設定
  - name: chatwoot
    description: カスタマーサポートのためのChatwoot統合
paths:
  /chatwoot/webhook:
    post:
      tags:
        - chatwoot
      summary: Chatwoot webhook エンドポイント
      description: >
        ChatwootからWebフックイベントを受信し、WhatsAppにメッセージを送信します。

        このURLをChatwoot受信トレイのWebhook設定で設定します。


        CHATWOOT_WEBHOOK_SECRET が設定されている場合、リクエストはそのシークレットを知っていることを

        証明する必要があります。 推奨：API チャンネルに Webhook シークレットが設定されている場合に Chatwoot が送信する、

        Chatwoot 独自の署名を使用します。`X-Chatwoot-Timestamp`（Unix 秒）と

        `X-Chatwoot-Signature: sha256=<hex HMAC-SHA256 of "<timestamp>.<raw
        body>">` です。

        タイムスタンプはサーバークロックのCHATWOOT_WEBHOOK_SIGNATURE_TOLERANCE (5m×

        default) 内になければなりません。 次の形式も受け付けます：`X-Hub-Signature-256`

        （生のリクエスト本文の HMAC-SHA256）、`X-Chatwoot-Webhook-Secret`

        または `X-Gowa-Chatwoot-Secret` に指定したシークレット、あるいは `secret` クエリパラメーター（非推奨：

        シークレットが URL やログに記録されるため）。


        適用されるシークレットは、ペイロードのルーティング先デバイスのシークレットです。

        そのデバイスの設定に `webhook_secret` がある場合はそれを使用します（この場合、

        そのデバイスではグローバルシークレットは受け付けません）。それ以外の場合やデバイスを特定できない場合は、CHATWOOT_WEBHOOK_SECRET

        を使用します。 許容時間内にすでに受け付けられた

        （2xx を返した）Chatwoot 署名付きリクエストには、

        200 を返し、処理は再実行しません。 

        に他のステータスで答えられたものは記憶されないため、同一の

        リクエストを再度送信することは処理されます。
      operationId: chatwootWebhook
      parameters:
        - name: X-Chatwoot-Signature
          in: header
          description: >-
            Chatwoot シグネチャ: sha256=<hex HMAC-SHA256 of "<timestamp>.<raw body>"
            webhook secretでキー指定>
          schema:
            type: string
        - name: X-Chatwoot-Timestamp
          in: header
          description: Unix時間（秒）でWebhookが署名されました
          schema:
            type: string
        - name: secret
          in: query
          description: Webhookシークレット。 落胆; 署名ヘッダを好む。
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Chatwoot Webhook ペイロード(Chatwoot documentationを参照)
      responses:
        '200':
          description: Webhook処理完了
        '401':
          description: シークレットまたは署名が存在しないか、リクエストが送信されるデバイスに対して無効であるか、または署名のタイムスタンプが許容範囲外です。
        '503':
          description: >-
            デバイスが利用できません。ルーティングされたデバイスの設定を読み取ることができませんでした。また、同一の署名リクエストが処理されたままです。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
components:
  schemas:
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: HTTP ステータスコードです
        message:
          type: string
          example: field cannot be blank
          description: 詳細エラーメッセージ
        results:
          type: object
          example: null
          description: 追加データ
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [デバイス毎のChatwoot Webhookエンドポイント](https://gowa-docs.mintlify.site/ja/api-reference/chatwoot/デバイス毎のchatwoot-webhookエンドポイント.md)
- [APIリファレンス](https://gowa-docs.mintlify.site/ja/api-reference/introduction.md)
- [Webhooks](https://gowa-docs.mintlify.site/ja/concepts/webhooks.md)
- [インストール](https://gowa-docs.mintlify.site/ja/installation.md)
- [API 認証](https://gowa-docs.mintlify.site/ja/api-reference/authentication.md)


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