Function WebhooksApiAxiosParamCreator

Returns {
    webhooksCreate: ((webhookWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
    webhooksCreateDeliveriesRedelivery: ((deliveryId, id, options?) => Promise<RequestArgs>);
    webhooksCreatePing: ((id, options?) => Promise<RequestArgs>);
    webhooksDestroy: ((id, options?) => Promise<RequestArgs>);
    webhooksList: ((xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, projectId?, search?, sort?, targetUrl?, type?, options?) => Promise<RequestArgs>);
    webhooksListDeliveries: ((id, page?, pageSize?, options?) => Promise<RequestArgs>);
    webhooksPartialUpdate: ((id, patchedWebhookWriteRequest?, options?) => Promise<RequestArgs>);
    webhooksRetrieve: ((id, options?) => Promise<RequestArgs>);
    webhooksRetrieveDeliveries: ((deliveryId, id, options?) => Promise<RequestArgs>);
    webhooksRetrieveEvents: ((type?, options?) => Promise<RequestArgs>);
    webhooksUpdate: ((id, webhookWriteRequest, options?) => Promise<RequestArgs>);
}

• webhooksCreate: ((webhookWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)

  • • (webhookWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>

    • Parameters

      • webhookWriteRequest: WebhookWriteRequest

      • Optional xOrganization: string

        Organization unique slug

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method creates a webhook

      Throws

• webhooksCreateDeliveriesRedelivery: ((deliveryId, id, options?) => Promise<RequestArgs>)

  • • (deliveryId, id, options?): Promise<RequestArgs>

    • Parameters

      • deliveryId: string

      • id: number

        A unique integer value identifying this webhook.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method redeliver a specific webhook delivery

      Throws

• webhooksCreatePing: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method send ping webhook

      Throws

• webhooksDestroy: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes a webhook

      Throws

• webhooksList: ((xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, projectId?, search?, sort?, targetUrl?, type?, options?) => Promise<RequestArgs>)

  • • (xOrganization?, filter?, org?, orgId?, owner?, page?, pageSize?, projectId?, search?, sort?, targetUrl?, type?, options?): Promise<RequestArgs>

    • Parameters

      • Optional xOrganization: string

        Organization unique slug

      • Optional filter: 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;].

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional owner: string

        A simple equality filter for the owner field

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional projectId: number

        A simple equality filter for the project_id field

      • Optional search: string

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

      • Optional sort: 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;]

      • Optional targetUrl: string

        A simple equality filter for the target_url field

      • Optional type: WebhooksListTypeEnum

        A simple equality filter for the type field

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns a paginated list of webhook according to query parameters

      Throws

• webhooksListDeliveries: ((id, page?, pageSize?, options?) => Promise<RequestArgs>)

  • • (id, page?, pageSize?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method return a list of deliveries for a specific webhook

      Throws

• webhooksPartialUpdate: ((id, patchedWebhookWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedWebhookWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • Optional patchedWebhookWriteRequest: PatchedWebhookWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in a webhook

      Throws

• webhooksRetrieve: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of a webhook

      Throws

• webhooksRetrieveDeliveries: ((deliveryId, id, options?) => Promise<RequestArgs>)

  • • (deliveryId, id, options?): Promise<RequestArgs>

    • Parameters

      • deliveryId: string

      • id: number

        A unique integer value identifying this webhook.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method return a specific delivery for a specific webhook

      Throws

• webhooksRetrieveEvents: ((type?, options?) => Promise<RequestArgs>)

  • • (type?, options?): Promise<RequestArgs>

    • Parameters

      • Optional type: string

        Type of webhook

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method return a list of available webhook events

      Throws

• webhooksUpdate: ((id, webhookWriteRequest, options?) => Promise<RequestArgs>)

  • • (id, webhookWriteRequest, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this webhook.

      • webhookWriteRequest: WebhookWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method updates a webhook by id

      Throws