client): WebhooksClient
새 WebhooksClient 인스턴스를 생성합니다
반환
WebhooksClient
정의 위치
webhooks/client.ts:162 ▸ createStreamLink(webhookId, options): Promise<Response>
스트림 링크 생성
지정된 webhook에 FilteredStream 이벤트를 전달하기 위한 링크를 생성합니다.
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다
정의 위치
webhooks/client.ts:207 ▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>
반환
Promise<WebhookLinksCreateResponse>
webhooks/client.ts:220
▸ deleteStreamLink(
webhookId, options): Promise<Response>
스트림 링크 삭제
FilteredStream 이벤트와 지정된 webhook 간의 링크를 삭제합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
webhooks/client.ts:433 ▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>
반환
Promise<WebhookLinksDeleteResponse>
정의 위치
webhooks/client.ts:446▸ getStreamLinks(
options): Promise<Response>
스트림 링크 가져오기
필터링된 스트림 규칙 세트와 연결된 웹훅 링크 목록을 가져옵니다.
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
webhooks/client.ts:527 ▸ getStreamLinks():Promise<WebhookLinksGetResponse>
반환값
Promise<WebhookLinksGetResponse>
webhooks/client.ts:536
▸ createWebhookReplayJob(
options): Promise<Response>
웹훅 재생 작업 생성
웹훅으로 전달되었거나 전달을 시도한 모든 이벤트에 대해, 최대 지난 24시간 이내의 이벤트를 가져오는 재생 작업을 생성합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response 객체
정의 위치
webhooks/client.ts:605 ▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>
반환
Promise<ReplayJobCreateResponse>
정의 위치
webhooks/client.ts:614▸ validate(
webhookId, options): Promise<Response>
웹훅을 검증합니다.
지정된 웹훅에 대해 CRC 검사를 수행합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다
webhooks/client.ts:704
▸ validate(webhookId): Promise<WebhookConfigPutResponse>
반환
Promise<WebhookConfigPutResponse>
webhooks/client.ts:717
▸ delete(
webhookId, options): Promise<Response>
웹훅 삭제
기존 웹훅 구성을 삭제합니다.
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response 객체를 반환합니다
정의 위치
webhooks/client.ts:808 ▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>
반환값
Promise<WebhookConfigDeleteResponse>
정의 위치
webhooks/client.ts:821▸ get(
options): Promise<Response>
웹훅 조회클라이언트 App과 연결된 웹훅 구성 목록을 조회합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise. 단, requestOptions.raw가 true인 경우에는 원본 Response.
webhooks/client.ts:908
▸ get(options?): Promise<Get2WebhooksResponse>
반환
Promise<Get2WebhooksResponse>
webhooks/client.ts:917
▸ create(
options): Promise<Response>
웹훅 만들기
새 웹훅 구성을 만듭니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response 객체
정의 위치
webhooks/client.ts:1023 ▸ create(options?): Promise<WebhookConfigCreateResponse>
반환값
Promise<WebhookConfigCreateResponse>
webhooks/client.ts:1032