Directus / @directus/sdk / rest / readWebhooks
Function: readWebhooks()
readWebhooks<
Schema
,TQuery
>(query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,UnpackList
<MergeCoreCollection
<Schema
,"directus_webhooks"
,Object
>>> extendsFF
?MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
,"directus_webhooks"
,Object
>>,FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
,"directus_webhooks"
,Object
>>,Exclude
<UnpackList
<Mutable
<...[...]>>,PickRelationalFields
<UnpackList
<...>> extendsnever
?never
:AllKeys
<... extends ... ? ... : ...>>>,FF
extendsRecord
<string
,string
> ?FF
:Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_webhooks", Object>> ? Extract<UnpackList<(...)>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }
>>[],Schema
>
List all Webhooks that exist in Directus.
Type parameters
• Schema extends object
• TQuery extends Query
<Schema
, DirectusWebhook
<Schema
>>
Parameters
• query?: TQuery
The query parameters
Returns
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, UnpackList
<MergeCoreCollection
<Schema
, "directus_webhooks"
, Object
>>> extends FF
? MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
, "directus_webhooks"
, Object
>>, FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
, "directus_webhooks"
, Object
>>, Exclude
<UnpackList
<Mutable
<...[...]>>, PickRelationalFields
<UnpackList
<...>> extends never
? never
: AllKeys
<... extends ... ? ... : ...>>>, FF
extends Record
<string
, string
> ? FF
: Record
<string
, string
>> : never
, PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extends never
? never
: { [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_webhooks", Object>> ? Extract<UnpackList<(...)>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }
>>[], Schema
>
An array of up to limit Webhook objects. If no items are available, data will be an empty array.