Function WebhooksApiFactory

Returns {
    webhooksCreate(requestParameters, options?) => AxiosPromise<WebhookRead>;
    webhooksCreateDeliveriesRedelivery(requestParameters, options?) => AxiosPromise<void>;
    webhooksCreatePing(requestParameters, options?) => AxiosPromise<WebhookDeliveryRead>;
    webhooksDestroy(requestParameters, options?) => AxiosPromise<void>;
    webhooksList(requestParameters?, options?) => AxiosPromise<PaginatedWebhookReadList>;
    webhooksListDeliveries(requestParameters, options?) => AxiosPromise<PaginatedWebhookDeliveryReadList>;
    webhooksPartialUpdate(requestParameters, options?) => AxiosPromise<WebhookRead>;
    webhooksRetrieve(requestParameters, options?) => AxiosPromise<WebhookRead>;
    webhooksRetrieveDeliveries(requestParameters, options?) => AxiosPromise<WebhookDeliveryRead>;
    webhooksRetrieveEvents(requestParameters?, options?) => AxiosPromise<Events>;
    webhooksUpdate(requestParameters, options?) => AxiosPromise<WebhookRead>;
}

• webhooksCreate:function

  • webhooksCreate(requestParameters, options?): AxiosPromise<WebhookRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookRead>

    Summary

    Method creates a webhook

    Throws

• webhooksCreateDeliveriesRedelivery:function

  • webhooksCreateDeliveriesRedelivery(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: WebhooksApiWebhooksCreateDeliveriesRedeliveryRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method redeliver a specific webhook delivery

    Throws

• webhooksCreatePing:function

  • webhooksCreatePing(requestParameters, options?): AxiosPromise<WebhookDeliveryRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksCreatePingRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookDeliveryRead>

    Summary

    Method send ping webhook

    Throws

• webhooksDestroy:function

  • webhooksDestroy(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: WebhooksApiWebhooksDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a webhook

    Throws

• webhooksList:function

  • webhooksList(requestParameters?, options?): AxiosPromise<PaginatedWebhookReadList>

  • Parameters

    • requestParameters: WebhooksApiWebhooksListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedWebhookReadList>

    Summary

    Method returns a paginated list of webhook according to query parameters

    Throws

• webhooksListDeliveries:function

  • webhooksListDeliveries(requestParameters, options?): AxiosPromise<PaginatedWebhookDeliveryReadList>

  • Parameters

    • requestParameters: WebhooksApiWebhooksListDeliveriesRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedWebhookDeliveryReadList>

    Summary

    Method return a list of deliveries for a specific webhook

    Throws

• webhooksPartialUpdate:function

  • webhooksPartialUpdate(requestParameters, options?): AxiosPromise<WebhookRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookRead>

    Summary

    Methods does a partial update of chosen fields in a webhook

    Throws

• webhooksRetrieve:function

  • webhooksRetrieve(requestParameters, options?): AxiosPromise<WebhookRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookRead>

    Summary

    Method returns details of a webhook

    Throws

• webhooksRetrieveDeliveries:function

  • webhooksRetrieveDeliveries(requestParameters, options?): AxiosPromise<WebhookDeliveryRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksRetrieveDeliveriesRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookDeliveryRead>

    Summary

    Method return a specific delivery for a specific webhook

    Throws

• webhooksRetrieveEvents:function

  • webhooksRetrieveEvents(requestParameters?, options?): AxiosPromise<Events>

  • Parameters

    • requestParameters: WebhooksApiWebhooksRetrieveEventsRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Events>

    Summary

    Method return a list of available webhook events

    Throws

• webhooksUpdate:function

  • webhooksUpdate(requestParameters, options?): AxiosPromise<WebhookRead>

  • Parameters

    • requestParameters: WebhooksApiWebhooksUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<WebhookRead>

    Summary

    Method updates a webhook by id

    Throws