Class Hooks

Index

Accessors

secrets

get secrets(): Secrets
Returns Secrets

Constructors

constructor

new Hooks(_options: Hooks.Options): Hooks
Parameters
- _options: Hooks.Options
Returns Hooks

Methods

list

list(
request?: Management.ListHooksRequestParameters,
requestOptions?: Hooks.RequestOptions,
): Promise<Page<Hook>>
Retrieve all hooks. Accepts a list of fields to include or exclude in the result.
Parameters
- request: Management.ListHooksRequestParameters = {}
- OptionalrequestOptions: Hooks.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Hook>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.hooks.list()
```

create

create(
request: Management.CreateHookRequestContent,
requestOptions?: Hooks.RequestOptions,
): HttpResponsePromise<CreateHookResponseContent>
Create a new hook.
Parameters
- request: Management.CreateHookRequestContent
- OptionalrequestOptions: Hooks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateHookResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange"
    })
```

get

get(
    id: string,
    request?: Management.GetHookRequestParameters,
    requestOptions?: Hooks.RequestOptions,
): HttpResponsePromise<GetHookResponseContent>
Retrieve a hook by its ID. Accepts a list of fields to include in the result.
Parameters
- id: string
  ID of the hook to retrieve.
- request: Management.GetHookRequestParameters = {}
- OptionalrequestOptions: Hooks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetHookResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.hooks.get("id")
```

delete

delete(
id: string,
requestOptions?: Hooks.RequestOptions,
): HttpResponsePromise<void>
Delete a hook.
Parameters
- id: string
  ID of the hook to delete.
- OptionalrequestOptions: Hooks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.hooks.delete("id")
```

update

update(
    id: string,
    request?: Management.UpdateHookRequestContent,
    requestOptions?: Hooks.RequestOptions,
): HttpResponsePromise<UpdateHookResponseContent>
Update an existing hook.
Parameters
- id: string
  ID of the hook to update.
- request: Management.UpdateHookRequestContent = {}
- OptionalrequestOptions: Hooks.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateHookResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.hooks.update("id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Hooks.Options

`Protected`_secrets

_secrets: undefined | Secrets

Class Hooks

Index

Accessors

Constructors

Methods

Properties

Accessors

secrets

Returns Secrets

Constructors

constructor

Parameters

Returns Hooks

Methods

list

Parameters

Returns Promise<Page<Hook>>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Protected_secrets

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options

`Protected`_secrets