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.

Constructores

constructor

• new WebhooksClient(client): WebhooksClient Crea una nueva instancia de WebhooksClient.

Parámetros

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

Devuelve

WebhooksClient

Definido en

webhooks/client.ts:162

Métodos

createStreamLink

▸ createStreamLink(webhookId, options): Promise<Response> Crear enlace de stream
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 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

Definido en

webhooks/client.ts:207 ▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

Parámetros

Nombre	Tipo
`webhookId`	`string`
`options?`	`CreateStreamLinkOptions`

Devuelve

Promise<WebhookLinksCreateResponse>

Definido en

webhooks/client.ts:220

deleteStreamLink

▸ deleteStreamLink(webhookId, options): Promise<Response> Eliminar enlace de transmisión Elimina un enlace de los eventos de FilteredStream al webhook indicado.

Parámetros

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

Definido en

webhooks/client.ts:433 ▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

Parámetros

Nombre	Tipo
`webhookId`	`string`

Devuelve

Promise<WebhookLinksDeleteResponse>

Definido en

webhooks/client.ts:446

getStreamLinks

▸ getStreamLinks(options): Promise<Response> Obtiene enlaces de stream Obtiene una lista de enlaces de webhook asociados con un conjunto de reglas de stream filtrado.

Parámetros

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

createWebhookReplayJob

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

Parámetros

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

Valores de retorno

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

Definido en

webhooks/client.ts:605 ▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>

Parámetros

Nombre	type
`options?`	`CreateWebhookReplayJobOptions`

Devuelve

Promise<ReplayJobCreateResponse>

Definido en

webhooks/client.ts:614

validate

▸ validate(webhookId, options): Promise<Response> Valida un webhook Inicia una comprobación CRC para un webhook determinado.

Parámetros

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

Definido en

webhooks/client.ts:704 ▸ validate(webhookId): Promise<WebhookConfigPutResponse>

Parámetros

Nombre	Tipo
`webhookId`	`string`

Devuelve

Promise<WebhookConfigPutResponse>

Definido en

webhooks/client.ts:717

delete

▸ delete(webhookId, options): Promise<Response> Eliminar el webhook
Elimina una configuración de webhook existente.

Parámetros

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

Definido en

webhooks/client.ts:808 ▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

Parámetros

Nombre	Tipo
`webhookId`	`string`

Devuelve

Promise<WebhookConfigDeleteResponse>

Definido en

webhooks/client.ts:821

get

▸ get(options): Promise<Response> Obtener webhook Obtiene una lista de configuraciones de webhooks asociadas a una App cliente.

Parámetros

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

Definido en

webhooks/client.ts:908 ▸ get(options?): Promise<Get2WebhooksResponse>

Parámetros

Nombre	Tipo
`options?`	`GetOptions`

Devuelve

Promise<Get2WebhooksResponse>

Definido en

webhooks/client.ts:917

create

▸ create(options): Promise<Response> Crear webhook Crea una nueva configuración de webhook.

Parámetros

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

Definido en

webhooks/client.ts:1023 ▸ create(options?): Promise<WebhookConfigCreateResponse>

Parámetros

Nombre	type
`options?`	`CreateOptions`

Devuelve

Promise<WebhookConfigCreateResponse>

Definido en

webhooks/client.ts:1032