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.

​

Constructeurs

​

constructor

• new WebhooksClient(client): WebhooksClient

Crée une nouvelle instance de client de webhooks

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale de Client pour X API

​

Renvoie

WebhooksClient

​

Défini dans

webhooks/client.ts:162

​

Méthodes

​

createStreamLink

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

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

​

Paramètres

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

▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

​

Paramètres

Nom	Type
webhookId	string
options?	CreateStreamLinkOptions

​

Renvoie

Promise<WebhookLinksCreateResponse>

​

Définition dans

webhooks/client.ts:220

---

​

deleteStreamLink

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

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

​

Paramètres

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

▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

​

Paramètres

Nom	Type
webhookId	string

​

Renvoie

Promise<WebhookLinksDeleteResponse>

​

Défini dans

webhooks/client.ts:446

---

​

getStreamLinks

▸ 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é.

​

Paramètres

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

▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

​

Renvoie

Promise<WebhookLinksGetResponse>

​

Défini dans

webhooks/client.ts:536

---

​

createWebhookReplayJob

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

​

Paramètres

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

▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

​

Paramètres

Nom	Type
options?	CreateWebhookReplayJobOptions

​

Renvoie

Promise<ReplayJobCreateResponse>

​

Défini dans

webhooks/client.ts:614

---

​

validate

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

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

​

Paramètres

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

​

Valeur de retour

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

▸ validate(webhookId): Promise<WebhookConfigPutResponse>

​

Paramètres

Nom	Type
webhookId	string

​

Renvoie

Promise<WebhookConfigPutResponse>

​

Défini dans

webhooks/client.ts:717

---

​

delete

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

Delete webhook Supprime la configuration d’un webhook existant.

​

Paramètres

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

▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

​

Paramètres

Nom	Type
webhookId	string

​

Renvoie

Promise<WebhookConfigDeleteResponse>

​

Défini dans

webhooks/client.ts:821

---

​

get

▸ get(options): Promise<Response>

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

​

Paramètres

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

▸ get(options?): Promise<Get2WebhooksResponse>

​

Paramètres

Nom	Type
options?	GetOptions

​

Retourne

Promise<Get2WebhooksResponse>

​

Défini dans

webhooks/client.ts:917

---

​

create

▸ create(options): Promise<Response>

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

​

Paramètres

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

▸ create(options?): Promise<WebhookConfigCreateResponse>

​

Paramètres

Nom	Type
options?	CreateOptions

​

Renvoie

Promise<WebhookConfigCreateResponse>

​

Défini dans

webhooks/client.ts:1032