WebhooksClient

웹훅 작업용 Client

이 Client는 X API의 웹훅 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 웹훅 관련 모든 작업에 대해 인증, 요청 형식 지정, 응답 구문 분석을 처리합니다.

​

생성자

​

constructor

• new WebhooksClient(client): WebhooksClient

새 WebhooksClient 인스턴스를 생성합니다

​

매개변수

Name	Type	Description
client	Client	주요 X API Client 인스턴스

​

반환

WebhooksClient

​

정의 위치

webhooks/client.ts:162

​

메서드

​

createStreamLink

▸ createStreamLink(webhookId, options): Promise<Response>

스트림 링크 생성 지정된 webhook에 FilteredStream 이벤트를 전달하기 위한 링크를 생성합니다.

​

매개변수

Name	Type	Description
webhookId	string	FilteredStream 규칙 세트에 연결할 webhook의 ID입니다.
options	CreateStreamLinkOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다

​

정의 위치

webhooks/client.ts:207

▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

​

매개변수

이름	타입
webhookId	string
options?	CreateStreamLinkOptions

​

반환

Promise<WebhookLinksCreateResponse>

​

정의된 위치

webhooks/client.ts:220

---

​

deleteStreamLink

▸ deleteStreamLink(webhookId, options): Promise<Response>

스트림 링크 삭제 FilteredStream 이벤트와 지정된 webhook 간의 링크를 삭제합니다.

​

매개변수

Name	Type	Description
webhookId	string	FilteredStream 규칙 집합에 연결할 webhook ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

​

정의 위치

webhooks/client.ts:433

▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

​

매개변수

이름	타입
webhookId	string

​

반환

Promise<WebhookLinksDeleteResponse>

​

정의 위치

webhooks/client.ts:446

---

​

getStreamLinks

▸ getStreamLinks(options): Promise<Response>

스트림 링크 가져오기 필터링된 스트림 규칙 세트와 연결된 웹훅 링크 목록을 가져옵니다.

​

매개변수

이름	type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

​

정의 위치

webhooks/client.ts:527

▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

​

반환값

Promise<WebhookLinksGetResponse>

​

정의된 위치

webhooks/client.ts:536

---

​

createWebhookReplayJob

▸ createWebhookReplayJob(options): Promise<Response>

웹훅 재생 작업 생성 웹훅으로 전달되었거나 전달을 시도한 모든 이벤트에 대해, 최대 지난 24시간 이내의 이벤트를 가져오는 재생 작업을 생성합니다.

​

매개변수

이름	type
options	CreateWebhookReplayJobOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response 객체

​

정의 위치

webhooks/client.ts:605

▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

​

매개변수

이름	type
options?	CreateWebhookReplayJobOptions

​

반환

Promise<ReplayJobCreateResponse>

​

정의 위치

webhooks/client.ts:614

---

​

validate

▸ validate(webhookId, options): Promise<Response>

웹훅을 검증합니다. 지정된 웹훅에 대해 CRC 검사를 수행합니다.

​

매개변수

이름	타입	설명
webhookId	string	확인할 웹훅의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다

​

정의된 위치

webhooks/client.ts:704

▸ validate(webhookId): Promise<WebhookConfigPutResponse>

​

매개변수

이름	유형
webhookId	string

​

반환

Promise<WebhookConfigPutResponse>

​

정의된 위치

webhooks/client.ts:717

---

​

delete

▸ delete(webhookId, options): Promise<Response>

웹훅 삭제 기존 웹훅 구성을 삭제합니다.

​

매개변수

이름	유형	설명
webhookId	string	삭제할 webhook의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response 객체를 반환합니다

​

정의 위치

webhooks/client.ts:808

▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

​

매개변수

이름	타입
webhookId	string

​

반환값

Promise<WebhookConfigDeleteResponse>

​

정의 위치

webhooks/client.ts:821

---

​

get

▸ get(options): Promise<Response>

웹훅 조회
클라이언트 App과 연결된 웹훅 구성 목록을 조회합니다.

​

매개변수

이름	type
options	GetOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise. 단, requestOptions.raw가 true인 경우에는 원본 Response.

​

정의된 위치

webhooks/client.ts:908

▸ get(options?): Promise<Get2WebhooksResponse>

​

매개변수

이름	type
options?	GetOptions

​

반환

Promise<Get2WebhooksResponse>

​

정의된 위치

webhooks/client.ts:917

---

​

create

▸ create(options): Promise<Response>

웹훅 만들기 새 웹훅 구성을 만듭니다.

​

매개변수

이름	type
options	CreateOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response 객체

​

정의 위치

webhooks/client.ts:1023

▸ create(options?): Promise<WebhookConfigCreateResponse>

​

매개변수

이름	type
options?	CreateOptions

​

반환값

Promise<WebhookConfigCreateResponse>

​

정의된 위치

webhooks/client.ts:1032