WebhooksClient

웹훅 작업을 위한 클라이언트 이 클라이언트는 X API의 webhooks 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 이 클라이언트는 인증, 요청 형식 지정, 그리고 모든 webhooks 관련 작업에 대한 응답 파싱을 처리합니다.

​

생성자

​

constructor

• new WebhooksClient(client): WebhooksClient 새로운 webhooks 클라이언트 인스턴스를 생성합니다.

​

매개변수

​

반환값

WebhooksClient

​

정의 위치

webhooks/client.ts:162

​

메서드

​

createStreamLink

▸ createStreamLink(webhookId, options): Promise<Response> 스트림 링크 생성 Creates a link to deliver FilteredStream events to the given webhook.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:207 ▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

​

매개변수

​

반환값

Promise<WebhookLinksCreateResponse>

​

정의 위치

webhooks/client.ts:220

---

​

deleteStreamLink

▸ deleteStreamLink(webhookId, options): Promise<Response> 스트림 링크 삭제 Deletes a link from FilteredStream events to the given webhook.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:433 ▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

​

매개변수

​

반환값

Promise<WebhookLinksDeleteResponse>

​

정의 위치

webhooks/client.ts:446

---

​

getStreamLinks

▸ getStreamLinks(options): Promise<Response> Get stream links 필터링된 스트림 규칙 집합과 연결된 webhook 링크 목록을 가져옵니다.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:527 ▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

​

반환값

Promise<WebhookLinksGetResponse>

​

정의 위치

webhooks/client.ts:536

---

​

createWebhookReplayJob

▸ createWebhookReplayJob(options): Promise<Response> 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.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:605 ▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

​

매개변수

​

반환값

Promise<ReplayJobCreateResponse>

​

정의 위치

webhooks/client.ts:614

---

​

validate

▸ validate(webhookId, options): Promise<Response> Validate webhook Triggers a CRC check for a given webhook.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:704 ▸ validate(webhookId): Promise<WebhookConfigPutResponse>

​

매개변수

​

반환값

Promise<WebhookConfigPutResponse>

​

정의 위치

webhooks/client.ts:717

---

​

delete

▸ delete(webhookId, options): Promise<Response> webhook 삭제 Deletes an existing webhook configuration.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:808 ▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

​

매개변수

​

반환값

Promise<WebhookConfigDeleteResponse>

​

정의 위치

webhooks/client.ts:821

---

​

get

▸ get(options): Promise<Response> Get webhook 클라이언트 앱과 연결된 webhook 구성 목록을 가져옵니다.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:908 ▸ get(options?): Promise<Get2WebhooksResponse>

​

매개변수

​

반환값

Promise<Get2WebhooksResponse>

​

정의 위치

webhooks/client.ts:917

---

​

create

▸ create(options): Promise<Response> webhook 생성 새로운 webhook 구성을 생성합니다.

​

매개변수

​

반환값

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

​

정의 위치

webhooks/client.ts:1023 ▸ create(options?): Promise<WebhookConfigCreateResponse>

​

매개변수

​

반환값

Promise<WebhookConfigCreateResponse>

​

정의 위치

webhooks/client.ts:1032