Class Webhooks

Index

Constructors

constructor

Methods

deleteWebhookById getDynamicWebhooksForApp getFailedWebhooks refreshWebhooks registerDynamicWebhooks

Constructors

constructor

new Webhooks(client: Client): Version3.Webhooks
Parameters
- client: Client
Returns Version3.Webhooks
- Defined in src/version3/webhooks.ts:8

Methods

deleteWebhookById

deleteWebhookById<T = unknown>(
parameters: Version3Parameters.DeleteWebhookById,
callback: Callback<T>,
): Promise<void>
Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteWebhookById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/webhooks.ts:102
deleteWebhookById<T = unknown>(
parameters: Version3Parameters.DeleteWebhookById,
callback?: undefined,
): Promise<T>
Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteWebhookById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/webhooks.ts:111

getDynamicWebhooksForApp

getDynamicWebhooksForApp<T = Version3Models.PageWebhook>(
parameters: undefined | Version3Parameters.GetDynamicWebhooksForApp,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of the webhooks registered by the calling app.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.PageWebhook
Parameters
- parameters: undefined | Version3Parameters.GetDynamicWebhooksForApp
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/webhooks.ts:18
getDynamicWebhooksForApp<T = Version3Models.PageWebhook>(
parameters?: Version3Parameters.GetDynamicWebhooksForApp,
callback?: undefined,
): Promise<T>
Returns a paginated list of the webhooks registered by the calling app.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.PageWebhook
Parameters
- Optionalparameters: Version3Parameters.GetDynamicWebhooksForApp
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/webhooks.ts:30

getFailedWebhooks

getFailedWebhooks<T = Version3Models.FailedWebhooks>(
parameters: undefined | Version3Parameters.GetFailedWebhooks,
callback: Callback<T>,
): Promise<void>
Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.

After 72 hours the failure may no longer be returned by this operation.

The oldest failure is returned first.

This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next.

Permissions required: Only Connect apps can use this operation.
Type Parameters
- T = Version3Models.FailedWebhooks
Parameters
- parameters: undefined | Version3Parameters.GetFailedWebhooks
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/webhooks.ts:141
getFailedWebhooks<T = Version3Models.FailedWebhooks>(
parameters?: Version3Parameters.GetFailedWebhooks,
callback?: undefined,
): Promise<T>
Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries.

After 72 hours the failure may no longer be returned by this operation.

The oldest failure is returned first.

This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next.

Permissions required: Only Connect apps can use this operation.
Type Parameters
- T = Version3Models.FailedWebhooks
Parameters
- Optionalparameters: Version3Parameters.GetFailedWebhooks
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/webhooks.ts:159

refreshWebhooks

refreshWebhooks<T = Version3Models.WebhooksExpirationDate>(
parameters: Version3Parameters.RefreshWebhooks,
callback: Callback<T>,
): Promise<void>
Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive.

Unrecognized webhook IDs (those that are not found or belong to other apps) are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.WebhooksExpirationDate
Parameters
- parameters: Version3Parameters.RefreshWebhooks
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/webhooks.ts:189
refreshWebhooks<T = Version3Models.WebhooksExpirationDate>(
parameters: Version3Parameters.RefreshWebhooks,
callback?: undefined,
): Promise<T>
Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive.

Unrecognized webhook IDs (those that are not found or belong to other apps) are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.WebhooksExpirationDate
Parameters
- parameters: Version3Parameters.RefreshWebhooks
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/webhooks.ts:203

registerDynamicWebhooks

registerDynamicWebhooks<T = Version3Models.ContainerForRegisteredWebhooks>(
parameters: Version3Parameters.RegisterDynamicWebhooks,
callback: Callback<T>,
): Promise<void>
Registers webhooks.

NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.ContainerForRegisteredWebhooks
Parameters
- parameters: Version3Parameters.RegisterDynamicWebhooks
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/webhooks.ts:60
registerDynamicWebhooks<T = Version3Models.ContainerForRegisteredWebhooks>(
parameters: Version3Parameters.RegisterDynamicWebhooks,
callback?: undefined,
): Promise<T>
Registers webhooks.

NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.
Type Parameters
- T = Version3Models.ContainerForRegisteredWebhooks
Parameters
- parameters: Version3Parameters.RegisterDynamicWebhooks
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/webhooks.ts:74

Class Webhooks

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Webhooks

Methods

deleteWebhookById

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getDynamicWebhooksForApp

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getFailedWebhooks

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

refreshWebhooks

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

registerDynamicWebhooks

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page