Interface WebhooksApiWebhooksListRequest

Request parameters for webhooksList operation in WebhooksApi.

Export

WebhooksApiWebhooksListRequest

Hierarchy

  • WebhooksApiWebhooksListRequest

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

Memberof

WebhooksApiWebhooksList

org?: string

Organization unique slug

Memberof

WebhooksApiWebhooksList

orgId?: number

Organization identifier

Memberof

WebhooksApiWebhooksList

owner?: string

A simple equality filter for the owner field

Memberof

WebhooksApiWebhooksList

page?: number

A page number within the paginated result set.

Memberof

WebhooksApiWebhooksList

pageSize?: number

Number of results to return per page.

Memberof

WebhooksApiWebhooksList

projectId?: number

A simple equality filter for the project_id field

Memberof

WebhooksApiWebhooksList

search?: string

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

Memberof

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

Memberof

WebhooksApiWebhooksList

targetUrl?: string

A simple equality filter for the target_url field

Memberof

WebhooksApiWebhooksList

A simple equality filter for the type field

Memberof

WebhooksApiWebhooksList

xOrganization?: string

Organization unique slug

Memberof

WebhooksApiWebhooksList

Generated using TypeDoc