WebhooksClient

Cliente para operaciones de webhooks

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

​

Constructores

​

constructor

• new WebhooksClient(client): WebhooksClient

Crea una nueva instancia del cliente de webhooks

​

Parámetros

Nombre	Tipo	Descripción
client	Client	La instancia principal del cliente de la X API

​

Devuelve

WebhooksClient

​

Definición en

webhooks/client.ts:96

​

Métodos

​

getStreamLinks

▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

Obtener enlaces de stream Obtener una lista de enlaces de webhook asociadas a un conjunto de reglas de stream filtrado.

​

Devuelve

Promise<WebhookLinksGetResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:109

---

​

createStreamLink

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

Crear enlace de transmisión Crea un enlace para entregar eventos de FilteredStream al webhook especificado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook que se vinculará a tu conjunto de reglas de FilteredStream.
options	CreateStreamLinkOptions	-

​

Devuelve

Promise<WebhookLinksCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:145

---

​

deleteStreamLink

▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

Eliminar enlace del stream Elimina un enlace entre los eventos de FilteredStream y el webhook indicado.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook para enlazar con tu conjunto de reglas de FilteredStream.

​

Devuelve

Promise<WebhookLinksDeleteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:225

---

​

validate

▸ validate(webhookId): Promise<WebhookConfigPutResponse>

Validar webhook Inicia una verificación CRC para un webhook específico.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook que se desea comprobar.

​

Devuelve

Promise<WebhookConfigPutResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:263

---

​

delete

▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

Eliminar webhook Elimina una configuración de webhook existente.

​

Parámetros

Nombre	Tipo	Descripción
webhookId	string	El id del webhook que se eliminará.

​

Devuelve

Promise<WebhookConfigDeleteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:301

---

​

get

▸ get(options?): Promise<Get2WebhooksResponse>

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

​

Parámetros

Nombre	Tipo
options	GetOptions

​

Devuelve

Promise<Get2WebhooksResponse>

Promesa que se resuelve en la respuesta de la API

​

Definido en

webhooks/client.ts:335

---

​

create

▸ create(options?): Promise<WebhookConfigCreateResponse>

Crear un webhook Crea una nueva configuración de webhook.

​

Parámetros

Nombre	Tipo
options	CreateOptions

​

Devuelve

Promise<WebhookConfigCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

webhooks/client.ts:376