Interface GetHooksRequest

Hierarchy

  • GetHooksRequest

Properties

enabled? fields? include_totals? page? per_page? triggerId?

Properties

Optional enabled

enabled?: boolean

Optional filter on whether a hook is enabled (true) or disabled (false).

Optional fields

fields?: string

Comma-separated list of fields to include in the result. Leave empty to retrieve all fields.

Optional include_totals

include_totals?: boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Optional page

page?: number

Page index of the results to return. First page is 0.

Optional per_page

per_page?: number

Number of results per page. Paging is disabled if parameter not sent.

Optional triggerId

triggerId?: GetHooksTriggerIdEnum

Retrieves hooks that match the trigger

Settings

Member Visibility

Theme

On This Page