Function WebhooksApiFp

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

• webhooksCreate:function

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

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

    Summary

    Method creates a webhook

    Throws

• webhooksCreateDeliveriesRedelivery:function

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

  • Parameters

    • deliveryId: string

    • id: number

      A unique integer value identifying this webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method redeliver a specific webhook delivery

    Throws

• webhooksCreatePing:function

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

  • Parameters

    • id: number

      A unique integer value identifying this webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method send ping webhook

    Throws

• webhooksDestroy:function

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

  • Parameters

    • id: number

      A unique integer value identifying this webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method deletes a webhook

    Throws

• webhooksList:function

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

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

    Summary

    Method returns a paginated list of webhook according to query parameters

    Throws

• webhooksListDeliveries:function

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

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

    Summary

    Method return a list of deliveries for a specific webhook

    Throws

• webhooksPartialUpdate:function

  • webhooksPartialUpdate(id, patchedWebhookWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this webhook.

    • Optional patchedWebhookWriteRequest: PatchedWebhookWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Methods does a partial update of chosen fields in a webhook

    Throws

• webhooksRetrieve:function

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

  • Parameters

    • id: number

      A unique integer value identifying this webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns details of a webhook

    Throws

• webhooksRetrieveDeliveries:function

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

  • Parameters

    • deliveryId: string

    • id: number

      A unique integer value identifying this webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method return a specific delivery for a specific webhook

    Throws

• webhooksRetrieveEvents:function

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

  • Parameters

    • Optional type: string

      Type of webhook

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method return a list of available webhook events

    Throws

• webhooksUpdate:function

  • webhooksUpdate(id, webhookWriteRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<WebhookRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this webhook.

    • webhookWriteRequest: WebhookWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method updates a webhook by id

    Throws