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

# WebhooksClient

> X API TypeScript SDK의 WebhooksClient 클래스에 대한 참조입니다. X API v2의 webhooks 엔드포인트를 위한 메서드, 매개변수 및 반환 타입입니다.

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

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

## 생성자

### constructor

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

새로운 webhooks 클라이언트 인스턴스를 생성합니다.

#### 매개변수

| 이름       | 타입                                                    | 설명                      |
| :------- | :---------------------------------------------------- | :---------------------- |
| `client` | [`Client`](/xdks/typescript/reference/classes/Client) | 메인 X API 클라이언트 인스턴스입니다. |

#### 반환값

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

#### 정의 위치

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

## 메서드

### createStreamLink

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

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

#### 매개변수

| 이름          | 타입                                                                      | 설명                                                     |
| :---------- | :---------------------------------------------------------------------- | :----------------------------------------------------- |
| `webhookId` | `string`                                                                | The webhook ID to link to your FilteredStream ruleset. |
| `options`   | `CreateStreamLinkOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                      |

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### deleteStreamLink

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

스트림 링크 삭제
Deletes a link from FilteredStream events to the given webhook.

#### 매개변수

| 이름                           | 타입       | 설명                                                     |
| :--------------------------- | :------- | :----------------------------------------------------- |
| `webhookId`                  | `string` | The webhook ID to link to your FilteredStream ruleset. |
| `options`                    | `Object` | -                                                      |
| `options.requestOptions`     | `Object` | -                                                      |
| `options.requestOptions.raw` | `true`   | -                                                      |

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### getStreamLinks

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

Get stream links
필터링된 스트림 규칙 집합과 연결된 webhook 링크 목록을 가져옵니다.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 반환값

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

#### 정의 위치

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

***

### 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.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

| 이름         | 타입                              |
| :--------- | :------------------------------ |
| `options?` | `CreateWebhookReplayJobOptions` |

#### 반환값

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

#### 정의 위치

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

***

### validate

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

Validate webhook
Triggers a CRC check for a given webhook.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### delete

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

webhook 삭제
Deletes an existing webhook configuration.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### get

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

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

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

| 이름         | 타입           |
| :--------- | :----------- |
| `options?` | `GetOptions` |

#### 반환값

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

#### 정의 위치

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

***

### create

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

webhook 생성
새로운 webhook 구성을 생성합니다.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

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

#### 정의 위치

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

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

#### 매개변수

| 이름         | 타입              |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### 반환값

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

#### 정의 위치

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