Class WebhooksApi

WebhooksApi - object-oriented interface

Export

WebhooksApi

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

createWalletWebhook createWebhook deleteWebhook listWebhooks updateWebhook

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWalletWebhook

  • createWalletWebhook(walletId, createWalletWebhookRequest?, options?): Promise<AxiosResponse<Webhook, any>>

  • Create a new webhook scoped to a wallet

    Parameters

    • walletId: string

      The ID of the wallet to create the webhook for.

    • Optional createWalletWebhookRequest: CreateWalletWebhookRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Webhook, any>>

    Summary

    Create a new webhook scoped to a wallet

    Throws

    Memberof

    WebhooksApi

createWebhook

deleteWebhook

  • deleteWebhook(webhookId, options?): Promise<AxiosResponse<void, any>>

  • Delete a webhook

    Parameters

    • webhookId: string

      The Webhook uuid that needs to be deleted

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Delete a webhook

    Throws

    Memberof

    WebhooksApi

listWebhooks

  • listWebhooks(limit?, page?, options?): Promise<AxiosResponse<WebhookList, any>>

  • List webhooks, optionally filtered by event type.

    Parameters

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<WebhookList, any>>

    Summary

    List webhooks

    Throws

    Memberof

    WebhooksApi

updateWebhook

  • updateWebhook(webhookId, updateWebhookRequest?, options?): Promise<AxiosResponse<Webhook, any>>

  • Update a webhook

    Parameters

    • webhookId: string

      The Webhook id that needs to be updated

    • Optional updateWebhookRequest: UpdateWebhookRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Webhook, any>>

    Summary

    Update a webhook

    Throws

    Memberof

    WebhooksApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletWebhookcreateWebhookdeleteWebhooklistWebhooksupdateWebhook