Skip to main content

하위 모듈

모듈 내용

이 모듈은 X API의 webhooks 엔드포인트에 대한 액세스를 제공합니다. 모든 webhooks-related 기능의 주요 진입점 역할을 합니다.

class xdk.webhooks.WebhooksClient

웹훅 작업을 위한 클라이언트

매개변수

Client

__init__

매개변수

Client

create

webhook 생성 새로운 webhook 구성을 생성합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateResponse

매개변수

CreateRequest
스트림 링크 생성 Creates a link to deliver FilteredStream events to the given webhook.

매개변수

Any
The webhook ID to link to your FilteredStream ruleset.
str or None
default:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
str or None
default:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
str or None
default:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
str or None
default:"None"
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
str or None
default:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
str or None
default:"None"
표시할 Place 필드의 쉼표로 구분된 목록입니다.

반환값

CreateStreamLinkResponse - 응답 데이터

create_webhook_replay_job

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: 요청 본문 :returns: 응답 데이터 :rtype: CreateWebhookReplayJobResponse

매개변수

CreateWebhookReplayJobRequest

delete

webhook 삭제 Deletes an existing webhook configuration.

매개변수

Any
The ID of the webhook to delete.

반환값

DeleteResponse - 응답 데이터 스트림 링크 삭제 Deletes a link from FilteredStream events to the given webhook.

매개변수

Any
The webhook ID to link to your FilteredStream ruleset.

반환값

DeleteStreamLinkResponse - 응답 데이터

get

Get webhook 클라이언트 앱과 연결된 webhook 구성 목록을 가져옵니다.

매개변수

List or None
default:"None"
A comma separated list of WebhookConfig fields to display.

반환값

GetResponse - 응답 데이터 Get stream links 필터링된 스트림 규칙 집합과 연결된 webhook 링크 목록을 가져옵니다. :returns: 응답 데이터 :rtype: GetStreamLinksResponse

반환값

GetStreamLinksResponse

validate

Validate webhook Triggers a CRC check for a given webhook.

매개변수

Any
The ID of the webhook to check.

반환값

ValidateResponse - 응답 데이터