diff --git a/.changeset/webhook-opt-in-retries.md b/.changeset/webhook-opt-in-retries.md deleted file mode 100644 index 11d1db909..000000000 --- a/.changeset/webhook-opt-in-retries.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/webhook": minor ---- - -feat: add opt-in retries to `IncomingWebhook` and `WebhookTrigger` diff --git a/.changeset/webhook-trigger-class.md b/.changeset/webhook-trigger-class.md deleted file mode 100644 index 1d30dd00e..000000000 --- a/.changeset/webhook-trigger-class.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/webhook": minor ---- - -feat: add `WebhookTrigger` class for Workflow Builder webhook triggers diff --git a/docs/english/reference/webhook/classes/IncomingWebhook.md b/docs/english/reference/webhook/classes/IncomingWebhook.md index 502b45229..2f5b3dd65 100644 --- a/docs/english/reference/webhook/classes/IncomingWebhook.md +++ b/docs/english/reference/webhook/classes/IncomingWebhook.md @@ -2,7 +2,7 @@ # Class: IncomingWebhook -Defined in: [packages/webhook/src/IncomingWebhook.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L12) +Defined in: [packages/webhook/src/IncomingWebhook.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L14) A client for Slack's Incoming Webhooks @@ -14,7 +14,7 @@ A client for Slack's Incoming Webhooks new IncomingWebhook(url, defaults?): IncomingWebhook; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L28) +Defined in: [packages/webhook/src/IncomingWebhook.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L35) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:28](https://github.com/slac send(message): Promise; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L60) +Defined in: [packages/webhook/src/IncomingWebhook.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L70) Send a notification to a conversation diff --git a/docs/english/reference/webhook/classes/WebhookTrigger.md b/docs/english/reference/webhook/classes/WebhookTrigger.md new file mode 100644 index 000000000..da576a4a2 --- /dev/null +++ b/docs/english/reference/webhook/classes/WebhookTrigger.md @@ -0,0 +1,59 @@ +[@slack/webhook](../index.md) / WebhookTrigger + +# Class: WebhookTrigger + +Defined in: [packages/webhook/src/WebhookTrigger.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L14) + +A client for Slack's Workflow Builder webhook triggers + +## See + +[https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack](https://slack.com/help/articles/360041352714-Build-a-workflow--Create-a-workflow-that-starts-outside-of-Slack) + +## Constructors + +### Constructor + +```ts +new WebhookTrigger(url, defaults?): WebhookTrigger; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L35) + +#### Parameters + +##### url + +`string` + +##### defaults? + +[`WebhookTriggerDefaultArguments`](../interfaces/WebhookTriggerDefaultArguments.md) = `...` + +#### Returns + +`WebhookTrigger` + +## Methods + +### send() + +```ts +send(payload?): Promise; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L69) + +Send a payload to the webhook trigger + +#### Parameters + +##### payload? + +[`WebhookTriggerSendArguments`](../interfaces/WebhookTriggerSendArguments.md) = `{}` + +arbitrary key-value data to send to the trigger + +#### Returns + +`Promise`\<[`WebhookTriggerResult`](../interfaces/WebhookTriggerResult.md)\> diff --git a/docs/english/reference/webhook/index.md b/docs/english/reference/webhook/index.md index d2b7e401e..3fcc037c3 100644 --- a/docs/english/reference/webhook/index.md +++ b/docs/english/reference/webhook/index.md @@ -1,4 +1,4 @@ -# @slack/webhook v7.1.0 +# @slack/webhook v7.2.0 ## Enumerations @@ -7,6 +7,7 @@ ## Classes - [IncomingWebhook](classes/IncomingWebhook.md) +- [WebhookTrigger](classes/WebhookTrigger.md) ## Interfaces @@ -16,10 +17,21 @@ - [IncomingWebhookRequestError](interfaces/IncomingWebhookRequestError.md) - [IncomingWebhookResult](interfaces/IncomingWebhookResult.md) - [IncomingWebhookSendArguments](interfaces/IncomingWebhookSendArguments.md) +- [RetryOptions](interfaces/RetryOptions.md) +- [WebhookTriggerDefaultArguments](interfaces/WebhookTriggerDefaultArguments.md) +- [WebhookTriggerResult](interfaces/WebhookTriggerResult.md) +- [WebhookTriggerSendArguments](interfaces/WebhookTriggerSendArguments.md) ## Type Aliases - [IncomingWebhookSendError](type-aliases/IncomingWebhookSendError.md) +- [WebhookTriggerHTTPError](type-aliases/WebhookTriggerHTTPError.md) +- [WebhookTriggerRequestError](type-aliases/WebhookTriggerRequestError.md) +- [WebhookTriggerSendError](type-aliases/WebhookTriggerSendError.md) + +## Variables + +- [retryPolicies](variables/retryPolicies.md) ## Functions diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md b/docs/english/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md index e6ec8bc05..4c42efe32 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md @@ -2,7 +2,7 @@ # Interface: IncomingWebhookDefaultArguments -Defined in: [packages/webhook/src/IncomingWebhook.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L100) +Defined in: [packages/webhook/src/IncomingWebhook.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L115) ## Extended by @@ -16,7 +16,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:100](https://github.com/sla optional agent: Agent; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) +Defined in: [packages/webhook/src/IncomingWebhook.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L122) *** @@ -26,7 +26,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:107](https://github.com/sla optional channel: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) +Defined in: [packages/webhook/src/IncomingWebhook.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L119) *** @@ -36,7 +36,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:104](https://github.com/sla optional icon_emoji: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L102) +Defined in: [packages/webhook/src/IncomingWebhook.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L117) *** @@ -46,7 +46,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:102](https://github.com/sla optional icon_url: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) +Defined in: [packages/webhook/src/IncomingWebhook.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L118) *** @@ -56,7 +56,17 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:103](https://github.com/sla optional link_names: boolean; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) +Defined in: [packages/webhook/src/IncomingWebhook.ts:121](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L121) + +*** + +### retryConfig? + +```ts +optional retryConfig: RetryOptions; +``` + +Defined in: [packages/webhook/src/IncomingWebhook.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L123) *** @@ -66,7 +76,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:106](https://github.com/sla optional text: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) +Defined in: [packages/webhook/src/IncomingWebhook.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L120) *** @@ -76,7 +86,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:105](https://github.com/sla optional timeout: number; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) +Defined in: [packages/webhook/src/IncomingWebhook.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L124) *** @@ -86,4 +96,4 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:108](https://github.com/sla optional username: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L101) +Defined in: [packages/webhook/src/IncomingWebhook.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L116) diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md b/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md index e5517f2d3..8e7b3d308 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md @@ -2,7 +2,7 @@ # Interface: IncomingWebhookHTTPError -Defined in: [packages/webhook/src/errors.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L25) +Defined in: [packages/webhook/src/errors.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L27) All errors produced by this package adhere to this interface @@ -18,7 +18,7 @@ All errors produced by this package adhere to this interface code: HTTPError; ``` -Defined in: [packages/webhook/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L26) +Defined in: [packages/webhook/src/errors.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L28) #### Overrides @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 original: Error; ``` -Defined in: [packages/webhook/src/errors.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L27) +Defined in: [packages/webhook/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L29) *** diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md b/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md index 6cf817c24..7b4458cdd 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md @@ -2,7 +2,7 @@ # Interface: IncomingWebhookRequestError -Defined in: [packages/webhook/src/errors.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L20) +Defined in: [packages/webhook/src/errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L21) All errors produced by this package adhere to this interface @@ -18,7 +18,7 @@ All errors produced by this package adhere to this interface code: RequestError; ``` -Defined in: [packages/webhook/src/errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L21) +Defined in: [packages/webhook/src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L22) #### Overrides @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 original: Error; ``` -Defined in: [packages/webhook/src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L22) +Defined in: [packages/webhook/src/errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L23) *** diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookResult.md b/docs/english/reference/webhook/interfaces/IncomingWebhookResult.md index d096e95f9..525c1be9a 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookResult.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookResult.md @@ -2,7 +2,7 @@ # Interface: IncomingWebhookResult -Defined in: [packages/webhook/src/IncomingWebhook.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L123) +Defined in: [packages/webhook/src/IncomingWebhook.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L139) ## Properties @@ -12,4 +12,4 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:123](https://github.com/sla text: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L124) +Defined in: [packages/webhook/src/IncomingWebhook.ts:140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L140) diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookSendArguments.md b/docs/english/reference/webhook/interfaces/IncomingWebhookSendArguments.md index 701447c14..25e130ca8 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookSendArguments.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookSendArguments.md @@ -2,7 +2,7 @@ # Interface: IncomingWebhookSendArguments -Defined in: [packages/webhook/src/IncomingWebhook.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L111) +Defined in: [packages/webhook/src/IncomingWebhook.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L127) ## Extends @@ -16,7 +16,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:111](https://github.com/sla optional agent: Agent; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) +Defined in: [packages/webhook/src/IncomingWebhook.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L122) #### Inherited from @@ -30,7 +30,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:107](https://github.com/sla optional attachments: MessageAttachment[]; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L112) +Defined in: [packages/webhook/src/IncomingWebhook.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L128) *** @@ -40,7 +40,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:112](https://github.com/sla optional blocks: (Block | KnownBlock)[]; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L113) +Defined in: [packages/webhook/src/IncomingWebhook.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L129) *** @@ -50,7 +50,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:113](https://github.com/sla optional channel: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) +Defined in: [packages/webhook/src/IncomingWebhook.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L119) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:104](https://github.com/sla optional icon_emoji: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L102) +Defined in: [packages/webhook/src/IncomingWebhook.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L117) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:102](https://github.com/sla optional icon_url: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) +Defined in: [packages/webhook/src/IncomingWebhook.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L118) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:103](https://github.com/sla optional link_names: boolean; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) +Defined in: [packages/webhook/src/IncomingWebhook.ts:121](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L121) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:106](https://github.com/sla optional metadata: object; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L116) +Defined in: [packages/webhook/src/IncomingWebhook.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L132) #### event\_payload @@ -122,13 +122,27 @@ event_type: string; *** +### retryConfig? + +```ts +optional retryConfig: RetryOptions; +``` + +Defined in: [packages/webhook/src/IncomingWebhook.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L123) + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`retryConfig`](IncomingWebhookDefaultArguments.md#retryconfig) + +*** + ### text? ```ts optional text: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) +Defined in: [packages/webhook/src/IncomingWebhook.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L120) #### Inherited from @@ -142,7 +156,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:105](https://github.com/sla optional timeout: number; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) +Defined in: [packages/webhook/src/IncomingWebhook.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L124) #### Inherited from @@ -156,7 +170,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:108](https://github.com/sla optional unfurl_links: boolean; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L114) +Defined in: [packages/webhook/src/IncomingWebhook.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L130) *** @@ -166,7 +180,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:114](https://github.com/sla optional unfurl_media: boolean; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L115) +Defined in: [packages/webhook/src/IncomingWebhook.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L131) *** @@ -176,7 +190,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:115](https://github.com/sla optional username: string; ``` -Defined in: [packages/webhook/src/IncomingWebhook.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L101) +Defined in: [packages/webhook/src/IncomingWebhook.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L116) #### Inherited from diff --git a/docs/english/reference/webhook/interfaces/RetryOptions.md b/docs/english/reference/webhook/interfaces/RetryOptions.md new file mode 100644 index 000000000..0bd50c82f --- /dev/null +++ b/docs/english/reference/webhook/interfaces/RetryOptions.md @@ -0,0 +1,203 @@ +[@slack/webhook](../index.md) / RetryOptions + +# Interface: RetryOptions + +Defined in: [packages/webhook/src/retry-policies.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/retry-policies.ts#L6) + +Options to create retry policies. Extends from https://github.com/tim-kos/node-retry. + +## Extends + +- `OperationOptions` + +## Properties + +### factor? + +```ts +optional factor: number; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:125 + +The exponential factor to use. + +#### Default + +```ts +2 +``` + +#### Inherited from + +```ts +OperationOptions.factor +``` + +*** + +### forever? + +```ts +optional forever: boolean; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:88 + +Whether to retry forever. + +#### Default + +```ts +false +``` + +#### Inherited from + +```ts +OperationOptions.forever +``` + +*** + +### maxRetryTime? + +```ts +optional maxRetryTime: number; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:98 + +The maximum time (in milliseconds) that the retried operation is allowed to run. + +#### Default + +```ts +Infinity +``` + +#### Inherited from + +```ts +OperationOptions.maxRetryTime +``` + +*** + +### maxTimeout? + +```ts +optional maxTimeout: number; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:135 + +The maximum number of milliseconds between two retries. + +#### Default + +```ts +Infinity +``` + +#### Inherited from + +```ts +OperationOptions.maxTimeout +``` + +*** + +### minTimeout? + +```ts +optional minTimeout: number; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:130 + +The number of milliseconds before starting the first retry. + +#### Default + +```ts +1000 +``` + +#### Inherited from + +```ts +OperationOptions.minTimeout +``` + +*** + +### randomize? + +```ts +optional randomize: boolean; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:140 + +Randomizes the timeouts by multiplying a factor between 1-2. + +#### Default + +```ts +false +``` + +#### Inherited from + +```ts +OperationOptions.randomize +``` + +*** + +### retries? + +```ts +optional retries: number; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:109 + +The maximum amount of times to retry the operation. + +#### Default + +```ts +10 +``` + +#### Inherited from + +```ts +OperationOptions.retries +``` + +*** + +### unref? + +```ts +optional unref: boolean; +``` + +Defined in: node\_modules/@types/retry/index.d.ts:93 + +Whether to [unref](https://nodejs.org/api/timers.html#timers_unref) the setTimeout's. + +#### Default + +```ts +false +``` + +#### Inherited from + +```ts +OperationOptions.unref +``` diff --git a/docs/english/reference/webhook/interfaces/WebhookTriggerDefaultArguments.md b/docs/english/reference/webhook/interfaces/WebhookTriggerDefaultArguments.md new file mode 100644 index 000000000..2d63cce6a --- /dev/null +++ b/docs/english/reference/webhook/interfaces/WebhookTriggerDefaultArguments.md @@ -0,0 +1,35 @@ +[@slack/webhook](../index.md) / WebhookTriggerDefaultArguments + +# Interface: WebhookTriggerDefaultArguments + +Defined in: [packages/webhook/src/WebhookTrigger.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L95) + +## Properties + +### agent? + +```ts +optional agent: Agent; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L96) + +*** + +### retryConfig? + +```ts +optional retryConfig: RetryOptions; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L97) + +*** + +### timeout? + +```ts +optional timeout: number; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L98) diff --git a/docs/english/reference/webhook/interfaces/WebhookTriggerResult.md b/docs/english/reference/webhook/interfaces/WebhookTriggerResult.md new file mode 100644 index 000000000..b0b697702 --- /dev/null +++ b/docs/english/reference/webhook/interfaces/WebhookTriggerResult.md @@ -0,0 +1,25 @@ +[@slack/webhook](../index.md) / WebhookTriggerResult + +# Interface: WebhookTriggerResult + +Defined in: [packages/webhook/src/WebhookTrigger.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L105) + +## Properties + +### error? + +```ts +optional error: string; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L107) + +*** + +### ok + +```ts +ok: boolean; +``` + +Defined in: [packages/webhook/src/WebhookTrigger.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L106) diff --git a/docs/english/reference/webhook/interfaces/WebhookTriggerSendArguments.md b/docs/english/reference/webhook/interfaces/WebhookTriggerSendArguments.md new file mode 100644 index 000000000..a7390c878 --- /dev/null +++ b/docs/english/reference/webhook/interfaces/WebhookTriggerSendArguments.md @@ -0,0 +1,11 @@ +[@slack/webhook](../index.md) / WebhookTriggerSendArguments + +# Interface: WebhookTriggerSendArguments + +Defined in: [packages/webhook/src/WebhookTrigger.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/WebhookTrigger.ts#L101) + +## Indexable + +```ts +[key: string]: string +``` diff --git a/docs/english/reference/webhook/type-aliases/WebhookTriggerHTTPError.md b/docs/english/reference/webhook/type-aliases/WebhookTriggerHTTPError.md new file mode 100644 index 000000000..d74b505d5 --- /dev/null +++ b/docs/english/reference/webhook/type-aliases/WebhookTriggerHTTPError.md @@ -0,0 +1,9 @@ +[@slack/webhook](../index.md) / WebhookTriggerHTTPError + +# Type Alias: WebhookTriggerHTTPError + +```ts +type WebhookTriggerHTTPError = IncomingWebhookHTTPError; +``` + +Defined in: [packages/webhook/src/errors.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L31) diff --git a/docs/english/reference/webhook/type-aliases/WebhookTriggerRequestError.md b/docs/english/reference/webhook/type-aliases/WebhookTriggerRequestError.md new file mode 100644 index 000000000..8196daa15 --- /dev/null +++ b/docs/english/reference/webhook/type-aliases/WebhookTriggerRequestError.md @@ -0,0 +1,9 @@ +[@slack/webhook](../index.md) / WebhookTriggerRequestError + +# Type Alias: WebhookTriggerRequestError + +```ts +type WebhookTriggerRequestError = IncomingWebhookRequestError; +``` + +Defined in: [packages/webhook/src/errors.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L25) diff --git a/docs/english/reference/webhook/type-aliases/WebhookTriggerSendError.md b/docs/english/reference/webhook/type-aliases/WebhookTriggerSendError.md new file mode 100644 index 000000000..ef8f467c8 --- /dev/null +++ b/docs/english/reference/webhook/type-aliases/WebhookTriggerSendError.md @@ -0,0 +1,11 @@ +[@slack/webhook](../index.md) / WebhookTriggerSendError + +# Type Alias: WebhookTriggerSendError + +```ts +type WebhookTriggerSendError = + | WebhookTriggerRequestError + | WebhookTriggerHTTPError; +``` + +Defined in: [packages/webhook/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L19) diff --git a/docs/english/reference/webhook/variables/retryPolicies.md b/docs/english/reference/webhook/variables/retryPolicies.md new file mode 100644 index 000000000..efb7b3f94 --- /dev/null +++ b/docs/english/reference/webhook/variables/retryPolicies.md @@ -0,0 +1,37 @@ +[@slack/webhook](../index.md) / retryPolicies + +# Variable: retryPolicies + +```ts +const retryPolicies: object; +``` + +Defined in: [packages/webhook/src/retry-policies.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/retry-policies.ts#L35) + +## Type Declaration + +### fiveRetriesInFiveMinutes + +```ts +fiveRetriesInFiveMinutes: RetryOptions; +``` + +Short & sweet, five retries in five minutes and then bail. + +### rapidRetryPolicy + +```ts +rapidRetryPolicy: RetryOptions; +``` + +This policy is just to keep the tests running fast. + +### tenRetriesInAboutThirtyMinutes + +```ts +tenRetriesInAboutThirtyMinutes: RetryOptions; +``` + +The default retry policy. Retry up to 10 times, over the span of about 30 minutes. It's not exact because +randomization has been added to prevent a stampeding herd problem (if all instances in your application are retrying +a request at the exact same intervals, they are more likely to cause failures for each other). diff --git a/package-lock.json b/package-lock.json index 8943a604c..d5fb6f919 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6500,14 +6500,14 @@ }, "packages/webhook": { "name": "@slack/webhook", - "version": "7.1.0", + "version": "7.2.0", "license": "MIT", "dependencies": { "@slack/types": "^2.20.1", "@types/node": ">=18", "@types/retry": "0.12.0", "axios": "^1.16.0", - "p-retry": "^4", + "p-retry": "^4.6.2", "retry": "^0.13.1" }, "devDependencies": { diff --git a/packages/webhook/CHANGELOG.md b/packages/webhook/CHANGELOG.md index 866cb02cb..7060ff8c4 100644 --- a/packages/webhook/CHANGELOG.md +++ b/packages/webhook/CHANGELOG.md @@ -1,5 +1,12 @@ # @slack/webhook +## 7.2.0 + +### Minor Changes + +- a2f6e77: feat: add opt-in retries to `IncomingWebhook` and `WebhookTrigger` +- a5bd5c8: feat: add `WebhookTrigger` class for Workflow Builder webhook triggers + ## 7.1.0 ### Minor Changes diff --git a/packages/webhook/package.json b/packages/webhook/package.json index 6d8cce589..07e586c56 100644 --- a/packages/webhook/package.json +++ b/packages/webhook/package.json @@ -1,6 +1,6 @@ { "name": "@slack/webhook", - "version": "7.1.0", + "version": "7.2.0", "description": "Official library for using the Slack Platform's Incoming Webhooks", "author": "Slack Technologies, LLC", "license": "MIT",