Function WebhooksApiFp

Returns {
    createWalletWebhook(walletId, createWalletWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>;
    createWebhook(createWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>;
    deleteWebhook(webhookId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    listWebhooks(limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookList>)>;
    updateWebhook(webhookId, updateWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>;
}

• createWalletWebhook:function

  • createWalletWebhook(walletId, createWalletWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>

  • 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<((axios?, basePath?) => AxiosPromise<Webhook>)>

    Summary

    Create a new webhook scoped to a wallet

    Throws

• createWebhook:function

  • createWebhook(createWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>

  • Create a new webhook

    Parameters

    • Optional createWebhookRequest: CreateWebhookRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>

    Summary

    Create a new webhook

    Throws

• deleteWebhook:function

  • deleteWebhook(webhookId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Delete a webhook

    Parameters

    • webhookId: string

      The Webhook uuid that needs to be deleted
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a webhook

    Throws

• listWebhooks:function

  • listWebhooks(limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookList>)>

  • 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<((axios?, basePath?) => AxiosPromise<WebhookList>)>

    Summary

    List webhooks

    Throws

• updateWebhook:function

  • updateWebhook(webhookId, updateWebhookRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Webhook>)>

  • 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<((axios?, basePath?) => AxiosPromise<Webhook>)>

    Summary

    Update a webhook

    Throws