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

Cliente para operaciones con webhooks

Este cliente proporciona métodos para interactuar con los endpoints de webhooks
de la X API. Se encarga de la autenticación, el formato de las solicitudes y el análisis
de las respuestas para todas las operaciones relacionadas con webhooks.

<div id="constructors">
  ## Constructores
</div>

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

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

Crea una nueva instancia de `WebhooksClient`.

<div id="parameters">
  #### Parámetros
</div>

| Nombre   | Type                                                     | Descripción                                    |
| :------- | :------------------------------------------------------- | :--------------------------------------------- |
| `client` | [`Client`](/es/xdks/typescript/reference/classes/Client) | La instancia principal del cliente de la X API |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</div>

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

<div id="methods">
  ## Métodos
</div>

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

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

Crear enlace de stream\
Crea un enlace para entregar eventos de FilteredStream al webhook especificado.

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo                                                                    | Descripción                                                                       |
| :---------- | :---------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |
| `webhookId` | `string`                                                                | El ID del webhook que se va a vincular a tu conjunto de reglas de FilteredStream. |
| `options`   | `CreateStreamLinkOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                 |

#### Returns

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo                      |
| :---------- | :------------------------ |
| `webhookId` | `string`                  |
| `options?`  | `CreateStreamLinkOptions` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</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`>

Eliminar enlace de transmisión
Elimina un enlace de los eventos de FilteredStream al webhook indicado.

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | Tipo     | Descripción                                                                   |
| :--------------------------- | :------- | :---------------------------------------------------------------------------- |
| `webhookId`                  | `string` | El id del webhook que se vinculará a tu conjunto de reglas de FilteredStream. |
| `options`                    | `Object` | -                                                                             |
| `options.requestOptions`     | `Object` | -                                                                             |
| `options.requestOptions.raw` | `true`   | -                                                                             |

#### Returns

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o el objeto Response sin procesar si `requestOptions.raw` es true

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</div>

[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`>

Obtiene enlaces de stream
Obtiene una lista de enlaces de webhook asociados con un conjunto de reglas de stream filtrado.

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | type     |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

#### Devuelve

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

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

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

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</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`>

Crear trabajo de reproducción para webhook\
Crea un trabajo de reproducción para recuperar eventos de hasta las últimas 24 horas correspondientes a todos los eventos que se hayan entregado o cuyo intento de entrega se haya realizado a ese webhook.

<div id="parameters">
  #### Parámetros
</div>

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

<div id="returns">
  #### Valores de retorno
</div>

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API o, si `requestOptions.raw` es true, con el objeto `Response` sin procesar

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | type                            |
| :--------- | :------------------------------ |
| `options?` | `CreateWebhookReplayJobOptions` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</div>

[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`>

Valida un webhook
Inicia una comprobación CRC para un webhook determinado.

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | Tipo     | Descripción                             |
| :--------------------------- | :------- | :-------------------------------------- |
| `webhookId`                  | `string` | El ID del webhook que se desea validar. |
| `options`                    | `Object` | -                                       |
| `options.requestOptions`     | `Object` | -                                       |
| `options.requestOptions.raw` | `true`   | -                                       |

#### Devuelve

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</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`>

Eliminar el webhook\
Elimina una configuración de webhook existente.

<div id="parameters">
  #### Parámetros
</div>

| Nombre                       | Tipo     | Descripción                             |
| :--------------------------- | :------- | :-------------------------------------- |
| `webhookId`                  | `string` | El ID del webhook que se va a eliminar. |
| `options`                    | `Object` | -                                       |
| `options.requestOptions`     | `Object` | -                                       |
| `options.requestOptions.raw` | `true`   | -                                       |

#### Devuelve

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre      | Tipo     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</div>

[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`>

Obtener webhook
Obtiene una lista de configuraciones de webhooks asociadas a una App cliente.

<div id="parameters">
  #### Parámetros
</div>

| Nombre    | Tipo                                                       |
| :-------- | :--------------------------------------------------------- |
| `options` | `GetOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Valor devuelto

`Promise`\<`Response`>

Promesa que se resuelve en la respuesta de la API, o en el objeto `Response` sin procesar si `requestOptions.raw` es true

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | Tipo         |
| :--------- | :----------- |
| `options?` | `GetOptions` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</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`>

Crear webhook
Crea una nueva configuración de webhook.

<div id="parameters">
  #### Parámetros
</div>

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

#### Devuelve

`Promise`\<`Response`>

Promesa que se resuelve con la respuesta de la API, o con el objeto `Response` sin procesar si `requestOptions.raw` es `true`

<div id="defined-in">
  #### Definido en
</div>

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

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

<div id="parameters">
  #### Parámetros
</div>

| Nombre     | type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### Devuelve

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

<div id="defined-in">
  #### Definido en
</div>

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