Class Hooks

constructor

• new Hooks(fetch: FetchFunction): Hooks

  Create a new Hooks instance.

  Parameters

  • fetch: FetchFunction

    Function for making API requests

  Returns Hooks

Readonlyincomings

create

• create(body: CreateHookBody): Promise<Hook>

  Create a new hook. Required hook-type parameters that have a default value in the hook type's manifest (e.g. method, headers, stringify for gateway-webhook) are filled by the API when omitted from data; values provided in data take precedence.

  Parameters

  • body: CreateHookBody

    The hook configuration to create

  Returns Promise<Hook>

  Promise with the created hook

delete

• delete(hookId: number): Promise<void>

  Delete a hook.

  Parameters

  • hookId: number

    The hook ID to delete

  Returns Promise<void>

disable

• disable(hookId: number): Promise<void>

  Disable a hook.

  Parameters

  • hookId: number

    The hook ID to disable

  Returns Promise<void>

enable

• enable(hookId: number): Promise<void>

  Enable a hook.

  Parameters

  • hookId: number

    The hook ID to enable

  Returns Promise<void>

get

• get(hookId: number): Promise<Hook>

  Get hook details.

  Parameters

  • hookId: number

    The hook ID to get details for

  Returns Promise<Hook>

  Promise with the hook details

learnStart

• learnStart(hookId: number): Promise<void>

  Start learning mode for a hook. Learning mode helps analyze incoming data structure

  Parameters

  • hookId: number

    The hook ID to start learning mode for

  Returns Promise<void>

learnStop

• learnStop(hookId: number): Promise<void>

  Stop learning mode for a hook.

  Parameters

  • hookId: number

    The hook ID to stop learning mode for

  Returns Promise<void>

list

• list(teamId: number, options?: ListHooksOptions): Promise<Hook[]>

  List all hooks for a team.

  Parameters

  • teamId: number

    The team ID to filter hooks by
  • Optionaloptions: ListHooksOptions

    Optional parameters for filtering

  Returns Promise<Hook[]>

  Promise with the list of hooks

listForOrganization

• listForOrganization(
      organizationId: number,
      options?: ListOrganizationHooksOptions,
  ): Promise<OrganizationHook[]>

  List hooks across the teams of an organization that the user can view, including private spaces.

  Parameters

  • organizationId: number

    The organization ID to list hooks for
  • Optionaloptions: ListOrganizationHooksOptions

    Optional filters (team, name, type, assignment, enabled state) and paging

  Returns Promise<OrganizationHook[]>

  Promise with the list of hooks

ping

• ping(hookId: number): Promise<HookPing>

  Ping a hook to check its status.

  Parameters

  • hookId: number

    The hook ID to ping

  Returns Promise<HookPing>

  Promise with the ping status

rename

• rename(hookId: number, name: string): Promise<Hook>

  Rename a hook.

  Parameters

  • hookId: number

    The hook ID to rename
  • name: string

    The new name for the hook

  Returns Promise<Hook>

  Promise with the updated hook

update

• update(hookId: number, body: UpdateHookBody): Promise<boolean>

  Update a hook's configuration data.

  Parameters

  • hookId: number

    The hook ID to update
  • body: UpdateHookBody

    The updated hook configuration

  Returns Promise<boolean>

  Promise with a boolean indicating success