Directus / @directus/sdk / rest / readWebhooks

Function: readWebhooks() ​

readWebhooks<Schema, TQuery>(query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { actions: ...; collections: ...; data: ...; headers: ...; id: ...; method: ...; name: ...; status: ...; url: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { actions: ...; collections: ...; data: ...; headers: ...; id: ...; method: ...; name: ...; status: ...; url: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Defined in: rest/commands/read/webhooks.ts:18

List all Webhooks that exist in Directus.

Type Parameters ​

• Schema

• TQuery extends Query<Schema, DirectusWebhook<Schema>>

Parameters ​

query? ​

TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { actions: ...; collections: ...; data: ...; headers: ...; id: ...; method: ...; name: ...; status: ...; url: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { actions: ...; collections: ...; data: ...; headers: ...; id: ...; method: ...; name: ...; status: ...; url: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

An array of up to limit Webhook objects. If no items are available, data will be an empty array.