> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# WebhooksClient

웹훅 작업용 Client

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

<div id="constructors">
  ## 생성자
</div>

<div id="constructor">
  ### constructor
</div>

• **new WebhooksClient**(`client`): [`WebhooksClient`](/ko/xdks/typescript/reference/classes/WebhooksClient)

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

<div id="parameters">
  #### 매개변수
</div>

| Name     | Type                                                     | Description          |
| :------- | :------------------------------------------------------- | :------------------- |
| `client` | [`Client`](/ko/xdks/typescript/reference/classes/Client) | 주요 X API Client 인스턴스 |

#### 반환

[`WebhooksClient`](/ko/xdks/typescript/reference/classes/WebhooksClient)

#### 정의 위치

[webhooks/client.ts:162](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L162)

<div id="methods">
  ## 메서드
</div>

<div id="createstreamlink">
  ### createStreamLink
</div>

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

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

<div id="parameters">
  #### 매개변수
</div>

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

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

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

#### 정의 위치

[webhooks/client.ts:207](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L207)

▸ **createStreamLink**(`webhookId`, `options?`): `Promise`\<[`WebhookLinksCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksCreateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름          | 타입                        |
| :---------- | :------------------------ |
| `webhookId` | `string`                  |
| `options?`  | `CreateStreamLinkOptions` |

#### 반환

`Promise`\<[`WebhookLinksCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksCreateResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:220](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L220)

***

<div id="deletestreamlink">
  ### deleteStreamLink
</div>

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

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

<div id="parameters">
  #### 매개변수
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L433)

▸ **deleteStreamLink**(`webhookId`): `Promise`\<[`WebhookLinksDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksDeleteResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름          | 타입       |
| :---------- | :------- |
| `webhookId` | `string` |

#### 반환

`Promise`\<[`WebhookLinksDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksDeleteResponse)>

#### 정의 위치

[webhooks/client.ts:446](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L446)

***

<div id="getstreamlinks">
  ### getStreamLinks
</div>

▸ **getStreamLinks**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### 매개변수
</div>

| 이름                           | type     |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

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

#### 정의 위치

[webhooks/client.ts:527](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L527)

▸ **getStreamLinks**(): `Promise`\<[`WebhookLinksGetResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksGetResponse)>

#### 반환값

`Promise`\<[`WebhookLinksGetResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookLinksGetResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:536](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L536)

***

<div id="createwebhookreplayjob">
  ### createWebhookReplayJob
</div>

▸ **createWebhookReplayJob**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### 매개변수
</div>

| 이름        | type                                                                          |
| :-------- | :---------------------------------------------------------------------------- |
| `options` | `CreateWebhookReplayJobOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

[webhooks/client.ts:605](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L605)

▸ **createWebhookReplayJob**(`options?`): `Promise`\<[`ReplayJobCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ReplayJobCreateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | type                            |
| :--------- | :------------------------------ |
| `options?` | `CreateWebhookReplayJobOptions` |

#### 반환

`Promise`\<[`ReplayJobCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ReplayJobCreateResponse)>

#### 정의 위치

[webhooks/client.ts:614](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L614)

***

<div id="validate">
  ### validate
</div>

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

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

<div id="parameters">
  #### 매개변수
</div>

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

#### 반환값

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:704](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L704)

▸ **validate**(`webhookId`): `Promise`\<[`WebhookConfigPutResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigPutResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름          | 유형       |
| :---------- | :------- |
| `webhookId` | `string` |

#### 반환

`Promise`\<[`WebhookConfigPutResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigPutResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:717](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L717)

***

<div id="delete">
  ### delete
</div>

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

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

<div id="parameters">
  #### 매개변수
</div>

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

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

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

#### 정의 위치

[webhooks/client.ts:808](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L808)

▸ **delete**(`webhookId`): `Promise`\<[`WebhookConfigDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigDeleteResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름          | 타입       |
| :---------- | :------- |
| `webhookId` | `string` |

#### 반환값

`Promise`\<[`WebhookConfigDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigDeleteResponse)>

#### 정의 위치

[webhooks/client.ts:821](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L821)

***

<div id="get">
  ### get
</div>

▸ **get**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### 매개변수
</div>

| 이름        | type                                                       |
| :-------- | :--------------------------------------------------------- |
| `options` | `GetOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 반환값

`Promise`\<`Response`>

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

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:908](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L908)

▸ **get**(`options?`): `Promise`\<[`Get2WebhooksResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2WebhooksResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | type         |
| :--------- | :----------- |
| `options?` | `GetOptions` |

#### 반환

`Promise`\<[`Get2WebhooksResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2WebhooksResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:917](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L917)

***

<div id="create">
  ### create
</div>

▸ **create**(`options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### 매개변수
</div>

| 이름        | type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

[webhooks/client.ts:1023](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L1023)

▸ **create**(`options?`): `Promise`\<[`WebhookConfigCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigCreateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### 반환값

`Promise`\<[`WebhookConfigCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.WebhookConfigCreateResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[webhooks/client.ts:1032](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/webhooks/client.ts#L1032)