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

# WebhooksClient

<div id="submodules">
  ## サブモジュール
</div>

* [xdk.webhooks.client モジュール](/ja/xdks/python/reference/xdk.webhooks.client)
  * [`WebhooksClient`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient)
    * [`WebhooksClient.__init__()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.__init__)
    * [`WebhooksClient.create()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.create)
    * [`WebhooksClient.create_stream_link()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.create_stream_link)
    * [`WebhooksClient.create_webhook_replay_job()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.create_webhook_replay_job)
    * [`WebhooksClient.delete()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.delete)
    * [`WebhooksClient.delete_stream_link()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.delete_stream_link)
    * [`WebhooksClient.get()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.get)
    * [`WebhooksClient.get_stream_links()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.get_stream_links)
    * [`WebhooksClient.validate()`](/ja/xdks/python/reference/xdk.webhooks.client#xdk.webhooks.client.WebhooksClient.validate)
* [xdk.webhooks.models モジュール](/ja/xdks/python/reference/xdk.webhooks.models)
  * [`CreateRequest`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateRequest)
    * [`CreateRequest.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateRequest.model_config)
  * [`CreateResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateResponse)
    * [`CreateResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateResponse.model_config)
  * [`CreateStreamLinkResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateStreamLinkResponse)
    * [`CreateStreamLinkResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateStreamLinkResponse.model_config)
  * [`CreateWebhookReplayJobRequest`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateWebhookReplayJobRequest)
    * [`CreateWebhookReplayJobRequest.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateWebhookReplayJobRequest.model_config)
  * [`CreateWebhookReplayJobResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateWebhookReplayJobResponse)
    * [`CreateWebhookReplayJobResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.CreateWebhookReplayJobResponse.model_config)
  * [`DeleteResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.DeleteResponse)
    * [`DeleteResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.DeleteResponse.model_config)
  * [`DeleteStreamLinkResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.DeleteStreamLinkResponse)
    * [`DeleteStreamLinkResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.DeleteStreamLinkResponse.model_config)
  * [`GetResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.GetResponse)
    * [`GetResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.GetResponse.model_config)
  * [`GetStreamLinksResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.GetStreamLinksResponse)
    * [`GetStreamLinksResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.GetStreamLinksResponse.model_config)
  * [`ValidateResponse`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.ValidateResponse)
    * [`ValidateResponse.model_config`](/ja/xdks/python/reference/xdk.webhooks.models#xdk.webhooks.models.ValidateResponse.model_config)

<div id="module-contents">
  ## モジュールの内容
</div>

このモジュールは X API の webhook エンドポイントへのアクセスを提供し、
webhook 関連のすべての機能に対する主なエントリポイントとして機能します。

<div id="class-xdkwebhookswebhooksclient">
  ### `class xdk.webhooks.WebhooksClient`
</div>

Webhook 操作用の Client クラス

#### パラメータ

<ParamField path="path.client" type="Client" />

<div id="__init__">
  ### `__init__`
</div>

#### パラメータ

<ParamField path="path.client" type="Client" />

<div id="create">
  ### `create`
</div>

Webhook を作成します
新しい Webhook 構成を作成します。
body: リクエストボディ
:returns: レスポンスデータ
:rtype: CreateResponse

#### パラメータ

<ParamField path="body.body" type="CreateRequest" />

<div id="create_stream_link">
  ### `create_stream_link`
</div>

ストリームリンクを作成する
FilteredStream イベントを指定された webhook に配信するためのリンクを作成します。

<div id="parameters">
  #### Parameters
</div>

<ParamField path="path.webhook_id" type="Any">
  FilteredStream ルールセットに関連付ける webhook の ID。
</ParamField>

<ParamField path="path.tweet_fields" type="str or None" default="None">
  表示するツイートのフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<ParamField path="path.expansions" type="str or None" default="None">
  展開するフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<ParamField path="path.media_fields" type="str or None" default="None">
  表示するメディアのフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<ParamField path="path.poll_fields" type="str or None" default="None">
  表示する投票のフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<ParamField path="path.user_fields" type="str or None" default="None">
  表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<ParamField path="path.place_fields" type="str or None" default="None">
  表示する場所のフィールドを、カンマ区切りのリストで指定します。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`CreateStreamLinkResponse` - レスポンスデータ

<div id="create_webhook_replay_job">
  ### `create_webhook_replay_job`
</div>

Webhook のリプレイジョブを作成
過去 24 時間以内に、その webhook に配信された、または配信が試行されたすべてのイベントを取得するためのリプレイジョブを作成します。
body: リクエストボディ
:returns: レスポンスデータ
:rtype: CreateWebhookReplayJobResponse

#### パラメータ

<ParamField path="body.body" type="CreateWebhookReplayJobRequest" />

<div id="delete">
  ### `delete`
</div>

Webhook を削除
既存の Webhook 設定を削除します。

#### パラメータ

<ParamField path="path.webhook_id" type="Any">
  削除する webhook の ID。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`DeleteResponse` - レスポンスデータ

<div id="delete_stream_link">
  ### `delete_stream_link`
</div>

ストリーム リンクを削除する
FilteredStream イベントと指定した webhook 間のリンクを削除します。

#### パラメーター

<ParamField path="path.webhook_id" type="Any">
  FilteredStream のルールセットに関連付ける webhook の識別子 (id) です。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`DeleteStreamLinkResponse` - レスポンスデータ

<div id="get">
  ### `get`
</div>

Webhook の取得
クライアント App に関連付けられた webhook 設定のリストを取得します。

#### パラメーター

<ParamField path="path.webhook_config_fields" type="List or None" default="None">
  表示する WebhookConfig フィールドをカンマ区切りで指定するリストです。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`GetResponse` - レスポンスデータ

<div id="get_stream_links">
  ### `get_stream_links`
</div>

ストリームリンクを取得
フィルタ済みストリームルールセットに関連付けられた webhook リンクの一覧を取得します。
:returns: レスポンスデータ
:rtype: GetStreamLinksResponse

<div id="returns">
  #### 戻り値
</div>

`GetStreamLinksResponse`

<div id="validate">
  ### `validate`
</div>

Webhook を検証します\
指定された Webhook に対して CRC チェックを実行します。

#### パラメーター

<ParamField path="path.webhook_id" type="Any">
  検証する webhook の ID。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`ValidateResponse` - レスポンスデータ