Interface WebhooksApiWebhooksListRequest

Request parameters for webhooksList operation in WebhooksApi.

WebhooksApiWebhooksListRequest

interface WebhooksApiWebhooksListRequest {
    filter?: string;
    org?: string;
    orgId?: number;
    owner?: string;
    page?: number;
    pageSize?: number;
    projectId?: number;
    search?: string;
    sort?: string;
    targetUrl?: string;
    type?: WebhooksListTypeEnum;
    xOrganization?: string;
}

Properties

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;].

WebhooksApiWebhooksList

org?: string

Organization unique slug

WebhooksApiWebhooksList

orgId?: number

Organization identifier

WebhooksApiWebhooksList

owner?: string

A simple equality filter for the owner field

WebhooksApiWebhooksList

page?: number

A page number within the paginated result set.

WebhooksApiWebhooksList

pageSize?: number

Number of results to return per page.

WebhooksApiWebhooksList

projectId?: number

A simple equality filter for the project_id field

WebhooksApiWebhooksList

search?: string

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

WebhooksApiWebhooksList

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;]

WebhooksApiWebhooksList

targetUrl?: string

A simple equality filter for the target_url field

WebhooksApiWebhooksList

A simple equality filter for the type field

WebhooksApiWebhooksList

xOrganization?: string

Organization unique slug

WebhooksApiWebhooksList