Class SDKWebhooks

Class providing methods for working with Webhooks

Index

Constructors

Methods

create delete get getSection list setSection update

Constructors

constructor

new SDKWebhooks(fetch: FetchFunction): SDKWebhooks
Parameters
- fetch: FetchFunction
Returns SDKWebhooks
- Defined in src/endpoints/sdk/webhooks.ts:76

Methods

create

create(
appName: string,
body: CreateSDKWebhookBody,
): Promise<Pick<SDKWebhook, "type" | "label">>
Create a new webhook for an app
Parameters
- appName: string
- body: CreateSDKWebhookBody
Returns Promise<Pick<SDKWebhook, "type" | "label">>
- Defined in src/endpoints/sdk/webhooks.ts:99

delete

delete(webhookName: string): Promise<void>
Delete a webhook
Parameters
- webhookName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/webhooks.ts:121

get

get(webhookName: string): Promise<SDKWebhook>
Get a single webhook by name
Parameters
- webhookName: string
Returns Promise<SDKWebhook>
- Defined in src/endpoints/sdk/webhooks.ts:91

getSection

getSection<T extends SDKWebhookSectionType>(
webhookName: string,
section: T,
): Promise<SDKWebhookSection<T>>
Get a specific section of a webhook Available sections are: api, parameters, attach, detach, scope
Type Parameters
- T extends SDKWebhookSectionType
Parameters
- webhookName: string
- section: T
Returns Promise<SDKWebhookSection<T>>
- Defined in src/endpoints/sdk/webhooks.ts:131

list

list(appName: string): Promise<SDKWebhook[]>
List webhooks for a specific app
Parameters
- appName: string
Returns Promise<SDKWebhook[]>
- Defined in src/endpoints/sdk/webhooks.ts:83

setSection

setSection<T extends SDKWebhookSectionType>(
    webhookName: string,
    section: T,
    body: SDKWebhookSection<T>,
): Promise<void>
Set a specific section of a webhook Available sections are: api, parameters, attach, detach, scope
Type Parameters
- T extends SDKWebhookSectionType
Parameters
- webhookName: string
- section: T
- body: SDKWebhookSection<T>
Returns Promise<void>
- Defined in src/endpoints/sdk/webhooks.ts:140

update

update(webhookName: string, body: UpdateSDKWebhookBody): Promise<SDKWebhook>
Update an existing webhook
Parameters
- webhookName: string
- body: UpdateSDKWebhookBody
Returns Promise<SDKWebhook>
- Defined in src/endpoints/sdk/webhooks.ts:110