> ## 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 pour les opérations de webhooks

Ce client fournit des méthodes pour interagir avec les endpoints de webhooks
de la X API. Il prend en charge l’authentification, la mise en forme des requêtes et l’analyse
des réponses pour l’ensemble des opérations liées aux webhooks.

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

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

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

Crée une nouvelle instance de client de webhooks

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type                                                     | Description                                  |
| :------- | :------------------------------------------------------- | :------------------------------------------- |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | L'instance principale de `Client` pour X API |

#### Renvoie

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

#### Défini dans

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

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

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

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

Créer un lien de flux
Crée un lien pour transmettre les événements FilteredStream au webhook indiqué.

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type                                                                    | Description                                                  |
| :---------- | :---------------------------------------------------------------------- | :----------------------------------------------------------- |
| `webhookId` | `string`                                                                | L’ID du webhook à lier à votre jeu de règles FilteredStream. |
| `options`   | `CreateStreamLinkOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                            |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` vaut true

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type                      |
| :---------- | :------------------------ |
| `webhookId` | `string`                  |
| `options?`  | `CreateStreamLinkOptions` |

#### Renvoie

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

<div id="defined-in">
  #### Définition dans
</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`>

Supprimer un lien de flux\
Supprime un lien entre les événements FilteredStream et le webhook spécifié.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                                                      |
| :--------------------------- | :------- | :--------------------------------------------------------------- |
| `webhookId`                  | `string` | L’ID du webhook à associer à votre jeu de règles FilteredStream. |
| `options`                    | `Object` | -                                                                |
| `options.requestOptions`     | `Object` | -                                                                |
| `options.requestOptions.raw` | `true`   | -                                                                |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou avec l’objet `Response` brut si `requestOptions.raw` est à `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Renvoie

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

#### Défini dans

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

Obtenir les liens de flux\
Obtenir une liste de liens de webhook associés à un jeu de règles de flux filtré.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` vaut true

#### Défini dans

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

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

#### Renvoie

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

#### Défini dans

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

Créer une tâche de relecture pour le webhook
Crée une tâche de relecture pour récupérer, sur les 24 dernières heures au maximum, tous les événements livrés ou dont la livraison au webhook a été tentée.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                                          |
| :-------- | :---------------------------------------------------------------------------- |
| `options` | `CreateWebhookReplayJobOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promise résolue avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` est `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                            |
| :--------- | :------------------------------ |
| `options?` | `CreateWebhookReplayJobOptions` |

#### Renvoie

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

#### Défini dans

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

Valide le webhook
Déclenche un contrôle CRC pour le webhook spécifié.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                          |
| :--------------------------- | :------- | :----------------------------------- |
| `webhookId`                  | `string` | L'identifiant du webhook à vérifier. |
| `options`                    | `Object` | -                                    |
| `options.requestOptions`     | `Object` | -                                    |
| `options.requestOptions.raw` | `true`   | -                                    |

<div id="returns">
  #### Valeur de retour
</div>

`Promise`\<`Response`>

Promise se résolvant en la réponse de l’API, ou en l’objet `Response` brut si `requestOptions.raw` a la valeur `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Renvoie

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

#### Défini dans

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

Delete webhook
Supprime la configuration d’un webhook existant.

<div id="parameters">
  #### Paramètres
</div>

| Nom                          | Type     | Description                           |
| :--------------------------- | :------- | :------------------------------------ |
| `webhookId`                  | `string` | L’identifiant du webhook à supprimer. |
| `options`                    | `Object` | -                                     |
| `options.requestOptions`     | `Object` | -                                     |
| `options.requestOptions.raw` | `true`   | -                                     |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type     |
| :---------- | :------- |
| `webhookId` | `string` |

#### Renvoie

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

#### Défini dans

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

Récupère le webhook\
Récupère la liste des configurations de webhook associées à une App cliente.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                       |
| :-------- | :--------------------------------------------------------- |
| `options` | `GetOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` est true

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type         |
| :--------- | :----------- |
| `options?` | `GetOptions` |

#### Retourne

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

#### Défini dans

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

Créer un webhook
Crée une nouvelle configuration de webhook.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### Renvoie

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou l’objet `Response` brut si `requestOptions.raw` vaut `true`

#### Défini dans

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

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

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### Renvoie

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

#### Défini dans

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