Class WebhookService

Index

Constructors

Methods

deleteWebhookById getItemWebhook getWebhook getWebhookById getWebhookByIdLogs getWebhookEvents getWebhookLogs postWebhook putWebhookById

Constructors

constructor

new WebhookService(): WebhookService
Returns WebhookService

Methods

`Static`deleteWebhookById

deleteWebhookById<ThrowOnError extends boolean = true>(
    options: Options<DeleteWebhookByIdData, ThrowOnError>,
): RequestResult<
    DeleteWebhookByIdResponses,
    DeleteWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a webhook.

Deletes a webhook identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteWebhookByIdData, ThrowOnError>
Returns RequestResult<
    DeleteWebhookByIdResponses,
    DeleteWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8653

`Static`getItemWebhook

getItemWebhook<ThrowOnError extends boolean = true>(
    options?: Options<GetItemWebhookData, ThrowOnError>,
): RequestResult<
    GetItemWebhookResponses,
    GetItemWebhookErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of webhook items.

Gets a collection of webhook items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemWebhookData, ThrowOnError>
Returns RequestResult<
    GetItemWebhookResponses,
    GetItemWebhookErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8595

`Static`getWebhook

getWebhook<ThrowOnError extends boolean = true>(
    options?: Options<GetWebhookData, ThrowOnError>,
): RequestResult<
    GetWebhookResponses,
    GetWebhookErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of webhooks.

Gets a paginated collection of all webhooks.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetWebhookData, ThrowOnError>
Returns RequestResult<GetWebhookResponses, GetWebhookErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:8613

`Static`getWebhookById

getWebhookById<ThrowOnError extends boolean = true>(
    options: Options<GetWebhookByIdData, ThrowOnError>,
): RequestResult<
    GetWebhookByIdResponses,
    GetWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a webhook.

Gets a webhook identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetWebhookByIdData, ThrowOnError>
Returns RequestResult<
    GetWebhookByIdResponses,
    GetWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8671

`Static`getWebhookByIdLogs

getWebhookByIdLogs<ThrowOnError extends boolean = true>(
    options: Options<GetWebhookByIdLogsData, ThrowOnError>,
): RequestResult<
    GetWebhookByIdLogsResponses,
    GetWebhookByIdLogsErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of webhook logs for a specific webhook.

Gets a paginated collection of webhook logs for the webhook identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetWebhookByIdLogsData, ThrowOnError>
Returns RequestResult<
    GetWebhookByIdLogsResponses,
    GetWebhookByIdLogsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8711

`Static`getWebhookEvents

getWebhookEvents<ThrowOnError extends boolean = true>(
    options?: Options<GetWebhookEventsData, ThrowOnError>,
): RequestResult<
    GetWebhookEventsResponses,
    GetWebhookEventsErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of webhook events.

Gets a paginated collection of available webhook events that can be subscribed to.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetWebhookEventsData, ThrowOnError>
Returns RequestResult<
    GetWebhookEventsResponses,
    GetWebhookEventsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8729

`Static`getWebhookLogs

getWebhookLogs<ThrowOnError extends boolean = true>(
    options?: Options<GetWebhookLogsData, ThrowOnError>,
): RequestResult<
    GetWebhookLogsResponses,
    GetWebhookLogsErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of webhook logs.

Gets a paginated collection of webhook logs for all webhooks.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetWebhookLogsData, ThrowOnError>
Returns RequestResult<
    GetWebhookLogsResponses,
    GetWebhookLogsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8747

`Static`postWebhook

postWebhook<ThrowOnError extends boolean = true>(
    options?: Options<PostWebhookData, ThrowOnError>,
): RequestResult<
    PostWebhookResponses,
    PostWebhookErrors,
    ThrowOnError,
    "fields",
>
Creates a new webhook.

Creates a new webhook with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostWebhookData, ThrowOnError>
Returns RequestResult<PostWebhookResponses, PostWebhookErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:8631

`Static`putWebhookById

putWebhookById<ThrowOnError extends boolean = true>(
    options: Options<PutWebhookByIdData, ThrowOnError>,
): RequestResult<
    PutWebhookByIdResponses,
    PutWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a webhook.

Updates a webhook identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutWebhookByIdData, ThrowOnError>
Returns RequestResult<
    PutWebhookByIdResponses,
    PutWebhookByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:8689

Class WebhookService

Index

Constructors

Methods

Constructors

constructor

Returns WebhookService

Methods

StaticdeleteWebhookById

Type Parameters

Parameters

Returns RequestResult< DeleteWebhookByIdResponses, DeleteWebhookByIdErrors, ThrowOnError, "fields",>

StaticgetItemWebhook

Type Parameters

Parameters

Returns RequestResult< GetItemWebhookResponses, GetItemWebhookErrors, ThrowOnError, "fields",>

StaticgetWebhook

Type Parameters

Parameters

Returns RequestResult<GetWebhookResponses, GetWebhookErrors, ThrowOnError, "fields">

StaticgetWebhookById

Type Parameters

Parameters

Returns RequestResult< GetWebhookByIdResponses, GetWebhookByIdErrors, ThrowOnError, "fields",>

StaticgetWebhookByIdLogs

Type Parameters

Parameters

Returns RequestResult< GetWebhookByIdLogsResponses, GetWebhookByIdLogsErrors, ThrowOnError, "fields",>

StaticgetWebhookEvents

Type Parameters

Parameters

Returns RequestResult< GetWebhookEventsResponses, GetWebhookEventsErrors, ThrowOnError, "fields",>

StaticgetWebhookLogs

Type Parameters

Parameters

Returns RequestResult< GetWebhookLogsResponses, GetWebhookLogsErrors, ThrowOnError, "fields",>

StaticpostWebhook

Type Parameters

Parameters

Returns RequestResult<PostWebhookResponses, PostWebhookErrors, ThrowOnError, "fields">

StaticputWebhookById

Type Parameters

Parameters

Returns RequestResult< PutWebhookByIdResponses, PutWebhookByIdErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteWebhookById

Returns RequestResult<
DeleteWebhookByIdResponses,
DeleteWebhookByIdErrors,
ThrowOnError,
"fields",
>

`Static`getItemWebhook

Returns RequestResult<
GetItemWebhookResponses,
GetItemWebhookErrors,
ThrowOnError,
"fields",
>

`Static`getWebhook

`Static`getWebhookById

Returns RequestResult<
GetWebhookByIdResponses,
GetWebhookByIdErrors,
ThrowOnError,
"fields",
>

`Static`getWebhookByIdLogs

Returns RequestResult<
GetWebhookByIdLogsResponses,
GetWebhookByIdLogsErrors,
ThrowOnError,
"fields",
>

`Static`getWebhookEvents

Returns RequestResult<
GetWebhookEventsResponses,
GetWebhookEventsErrors,
ThrowOnError,
"fields",
>

`Static`getWebhookLogs

Returns RequestResult<
GetWebhookLogsResponses,
GetWebhookLogsErrors,
ThrowOnError,
"fields",
>

`Static`postWebhook

`Static`putWebhookById

Returns RequestResult<
PutWebhookByIdResponses,
PutWebhookByIdErrors,
ThrowOnError,
"fields",
>