Class Hooks

Class providing methods for working with Make hooks. Hooks refer to the webhooks and mailhooks available in Make that notify you whenever a certain change occurs in the connected app or service.

Index

Constructors

Methods

create delete disable enable get learnStart learnStop list ping rename update

Constructors

constructor

new Hooks(fetch: FetchFunction): Hooks
Create a new Hooks instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns Hooks
- Defined in src/endpoints/hooks.ts:150

Methods

create

create(body: CreateHookBody): Promise<Hook>
Create a new hook.
Parameters
- body: CreateHookBody
  The hook configuration to create
Returns Promise<Hook>
Promise with the created hook
- Defined in src/endpoints/hooks.ts:178

delete

delete(hookId: number): Promise<void>
Delete a hook.
Parameters
- hookId: number
  The hook ID to delete
Returns Promise<void>
- Defined in src/endpoints/hooks.ts:236

disable

disable(hookId: number): Promise<void>
Disable a hook.
Parameters
- hookId: number
  The hook ID to disable
Returns Promise<void>
- Defined in src/endpoints/hooks.ts:268

enable

enable(hookId: number): Promise<void>
Enable a hook.
Parameters
- hookId: number
  The hook ID to enable
Returns Promise<void>
- Defined in src/endpoints/hooks.ts:258

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
- Defined in src/endpoints/hooks.ts:196

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>
- Defined in src/endpoints/hooks.ts:279

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>
- Defined in src/endpoints/hooks.ts:289

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
- Defined in src/endpoints/hooks.ts:160

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
- Defined in src/endpoints/hooks.ts:250

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
- Defined in src/endpoints/hooks.ts:206

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
- Defined in src/endpoints/hooks.ts:223