Construtores
constructor
• new WebhooksClient(client): WebhooksClient
Cria uma nova instância do client webhooks
Parâmetros
Retorna
WebhooksClient
Definido em
webhooks/client.ts:162Métodos
createStreamLink
▸ createStreamLink(webhookId, options): Promise<Response>
Create stream link
Creates a link to deliver FilteredStream events to the given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:207 ▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>
Parâmetros
Retorna
Promise<WebhookLinksCreateResponse>
Definido em
webhooks/client.ts:220deleteStreamLink
▸ deleteStreamLink(webhookId, options): Promise<Response>
Delete stream link
Deletes a link from FilteredStream events to the given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:433 ▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>
Parâmetros
Retorna
Promise<WebhookLinksDeleteResponse>
Definido em
webhooks/client.ts:446getStreamLinks
▸ getStreamLinks(options): Promise<Response>
Get stream links
Get a list of webhook links associated with a filtered stream ruleset.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:527 ▸ getStreamLinks():Promise<WebhookLinksGetResponse>
Retorna
Promise<WebhookLinksGetResponse>
Definido em
webhooks/client.ts:536createWebhookReplayJob
▸ createWebhookReplayJob(options): Promise<Response>
Create replay job for webhook
Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:605 ▸ createWebhookReplayJob(options?): Promise<ReplayJobCreateResponse>
Parâmetros
Retorna
Promise<ReplayJobCreateResponse>
Definido em
webhooks/client.ts:614validate
▸ validate(webhookId, options): Promise<Response>
Validate webhook
Triggers a CRC check for a given webhook.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:704 ▸ validate(webhookId): Promise<WebhookConfigPutResponse>
Parâmetros
Retorna
Promise<WebhookConfigPutResponse>
Definido em
webhooks/client.ts:717delete
▸ delete(webhookId, options): Promise<Response>
Delete webhook
Deletes an existing webhook configuration.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:808 ▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>
Parâmetros
Retorna
Promise<WebhookConfigDeleteResponse>
Definido em
webhooks/client.ts:821get
▸ get(options): Promise<Response>
Get webhook
Get a list of webhook configs associated with a client app.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:908 ▸ get(options?): Promise<Get2WebhooksResponse>
Parâmetros
Retorna
Promise<Get2WebhooksResponse>
Definido em
webhooks/client.ts:917create
▸ create(options): Promise<Response>
Create webhook
Creates a new webhook configuration.
Parâmetros
Retorna
Promise<Response>
Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true
Definido em
webhooks/client.ts:1023 ▸ create(options?): Promise<WebhookConfigCreateResponse>
Parâmetros
Retorna
Promise<WebhookConfigCreateResponse>