Class HooksClient

Index

Accessors

secrets

get secrets(): SecretsClient

Returns SecretsClient

Constructors

constructor

new HooksClient(options: BaseClientOptions): HooksClient
Parameters
- options: BaseClientOptions
Returns HooksClient

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.hooks.list({
        page: 1,
        per_page: 1,
        include_totals: true,
        enabled: true,
        fields: "fields",
        triggerId: "credentials-exchange"
    })
```

create

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

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

get

get(
    id: string,
    request?: GetHookRequestParameters,
    requestOptions?: HooksClient.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: GetHookRequestParameters = {}
- OptionalrequestOptions: HooksClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetHookResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.hooks.get("id", {
        fields: "fields"
    })
```

delete

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.hooks.delete("id")
```

update

update(
    id: string,
    request?: UpdateHookRequestContent,
    requestOptions?: HooksClient.RequestOptions,
): HttpResponsePromise<UpdateHookResponseContent>
Update an existing hook.
Parameters
- id: string
  ID of the hook to update.
- request: UpdateHookRequestContent = {}
- OptionalrequestOptions: HooksClient.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

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.hooks.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_secrets

_secrets: SecretsClient | undefined

Class HooksClient

Index

Accessors

Constructors

Methods

Properties

Accessors

secrets

Returns SecretsClient

Constructors

constructor

Parameters

Returns HooksClient

Methods

list

Parameters

Returns Promise<Page<Hook, ListHooksOffsetPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateHookResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_secrets

Settings

On This Page

`Protected` `Readonly`_options

`Protected`_secrets