HooksApi API

The hooksApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
create
delete
disable
enable
get
initialize
list
update

Methods

---

create

plugin.hooksApi.create(data: CreateHookRequest): Promise<Hook>

Parameter	Type	Required	Description
data	CreateHookRequest	Yes

Returns: Promise<Hook>

Full reference →

---

delete

plugin.hooksApi.delete(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

disable

plugin.hooksApi.disable(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

enable

plugin.hooksApi.enable(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

get

plugin.hooksApi.get(id: string): Promise<Hook>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<Hook>

Full reference →

---

initialize

plugin.hooksApi.initialize(data?: InitializeHooksRequest): Promise<unknown>

Parameter	Type	Required	Description
data	InitializeHooksRequest	No

Returns: Promise<unknown>

Full reference →

---

list

plugin.hooksApi.list(params?: Record<string, unknown>): Promise<Hook[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<Hook[]>

Full reference →

---

update

plugin.hooksApi.update(id: string, data: UpdateHookRequest): Promise<Hook>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateHookRequest	Yes

Returns: Promise<Hook>

Full reference →