Function WebhooksApiFp

Returns {
    webhooksCreate(
        webhookWriteRequest: WebhookWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >;
    webhooksCreateDeliveriesRedelivery(
        deliveryId: string,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    webhooksCreatePing(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >;
    webhooksDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    webhooksList(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        search?: string,
        sort?: string,
        targetUrl?: string,
        type?: WebhooksListTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookReadList>,
    >;
    webhooksListDeliveries(
        id: number,
        page?: number,
        pageSize?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookDeliveryReadList>,
    >;
    webhooksPartialUpdate(
        id: number,
        patchedWebhookWriteRequest?: PatchedWebhookWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >;
    webhooksRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >;
    webhooksRetrieveDeliveries(
        deliveryId: string,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >;
    webhooksRetrieveEvents(
        type?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Events>,
    >;
    webhooksUpdate(
        id: number,
        webhookWriteRequest: WebhookWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >;
}

• webhooksCreate:function

  • webhooksCreate(
        webhookWriteRequest: WebhookWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >

    Parameters

    • webhookWriteRequest: WebhookWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>>

    Throws

• webhooksCreateDeliveriesRedelivery:function

  • webhooksCreateDeliveriesRedelivery(
        deliveryId: string,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • deliveryId: string
    • id: number

      A unique integer value identifying this webhook.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• webhooksCreatePing:function

  • webhooksCreatePing(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >

    Throws

• webhooksDestroy:function

  • webhooksDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• webhooksList:function

  • webhooksList(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        search?: string,
        sort?: string,
        targetUrl?: string,
        type?: WebhooksListTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookReadList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalfilter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;target_url&#39;, &#39;owner&#39;, &#39;type&#39;, &#39;description&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;].
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • OptionalprojectId: number

      A simple equality filter for the project_id field
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;target_url&#39;, &#39;owner&#39;, &#39;type&#39;, &#39;description&#39;)
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;target_url&#39;, &#39;owner&#39;, &#39;type&#39;, &#39;description&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]
    • OptionaltargetUrl: string

      A simple equality filter for the target_url field
    • Optionaltype: WebhooksListTypeEnum

      A simple equality filter for the type field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookReadList>,
    >

    Throws

• webhooksListDeliveries:function

  • webhooksListDeliveries(
        id: number,
        page?: number,
        pageSize?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookDeliveryReadList>,
    >

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedWebhookDeliveryReadList>,
    >

    Throws

• webhooksPartialUpdate:function

  • webhooksPartialUpdate(
        id: number,
        patchedWebhookWriteRequest?: PatchedWebhookWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • OptionalpatchedWebhookWriteRequest: PatchedWebhookWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>>

    Throws

• webhooksRetrieve:function

  • webhooksRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>>

    Throws

• webhooksRetrieveDeliveries:function

  • webhooksRetrieveDeliveries(
        deliveryId: string,
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >

    Parameters

    • deliveryId: string
    • id: number

      A unique integer value identifying this webhook.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WebhookDeliveryRead>,
    >

    Throws

• webhooksRetrieveEvents:function

  • webhooksRetrieveEvents(
        type?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Events>,
    >

    Parameters

    • Optionaltype: string

      Type of webhook
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Events>>

    Throws

• webhooksUpdate:function

  • webhooksUpdate(
        id: number,
        webhookWriteRequest: WebhookWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this webhook.
    • webhookWriteRequest: WebhookWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookRead>>

    Throws