WebhooksClient

​

サブモジュール

• xdk.webhooks.client module
  • WebhooksClient
    • WebhooksClient.__init__()
    • WebhooksClient.create()
    • WebhooksClient.create_stream_link()
    • WebhooksClient.create_webhook_replay_job()
    • WebhooksClient.delete()
    • WebhooksClient.delete_stream_link()
    • WebhooksClient.get()
    • WebhooksClient.get_stream_links()
    • WebhooksClient.validate()
• xdk.webhooks.models module
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • CreateStreamLinkResponse
    • CreateStreamLinkResponse.model_config
  • CreateWebhookReplayJobRequest
    • CreateWebhookReplayJobRequest.model_config
  • CreateWebhookReplayJobResponse
    • CreateWebhookReplayJobResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • DeleteStreamLinkResponse
    • DeleteStreamLinkResponse.model_config
  • GetResponse
    • GetResponse.model_config
  • GetStreamLinksResponse
    • GetStreamLinksResponse.model_config
  • ValidateResponse
    • ValidateResponse.model_config

​

モジュールの内容

このモジュールは、X API の webhooks エンドポイントへのアクセスを提供します webhooks-related のすべての機能の主要なエントリポイントとして機能します。

​

class xdk.webhooks.WebhooksClient

webhooks 操作向けのクライアント

​

パラメーター

​

__init__

​

パラメーター

​

create

Create webhook Creates a new webhook configuration. body: Request body :returns: レスポンスデータ :rtype: CreateResponse

​

パラメーター

​

create_stream_link

Create stream link Creates a link to deliver FilteredStream events to the given webhook.

​

パラメーター

​

戻り値

CreateStreamLinkResponse - Response data

​

create_webhook_replay_job

Create replay job for webhook Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook. body: Request body :returns: レスポンスデータ :rtype: CreateWebhookReplayJobResponse

​

パラメーター

​

delete

Delete webhook Deletes an existing webhook configuration.

​

パラメーター

​

戻り値

DeleteResponse - Response data

​

delete_stream_link

Delete stream link Deletes a link from FilteredStream events to the given webhook.

​

パラメーター

​

戻り値

DeleteStreamLinkResponse - Response data

​

get

Get webhook Get a list of webhook configs associated with a client app.

​

パラメーター

​

戻り値

GetResponse - Response data

​

get_stream_links

Get stream links Get a list of webhook links associated with a filtered stream ruleset. :returns: レスポンスデータ :rtype: GetStreamLinksResponse

​

戻り値

GetStreamLinksResponse

​

validate

Validate webhook Triggers a CRC check for a given webhook.

​

パラメーター

​

戻り値

ValidateResponse - Response data