Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/webhook-opt-in-retries.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/webhook-trigger-class.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/english/reference/webhook/classes/IncomingWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -38,7 +38,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:28](https://github.com/slac
send(message): Promise<IncomingWebhookResult>;
```

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

Expand Down
59 changes: 59 additions & 0 deletions docs/english/reference/webhook/classes/WebhookTrigger.md
Original file line number Diff line number Diff line change
@@ -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<WebhookTriggerResult>;
```

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)\>
14 changes: 13 additions & 1 deletion docs/english/reference/webhook/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/webhook v7.1.0
# @slack/webhook v7.2.0

## Enumerations

Expand All @@ -7,6 +7,7 @@
## Classes

- [IncomingWebhook](classes/IncomingWebhook.md)
- [WebhookTrigger](classes/WebhookTrigger.md)

## Interfaces

Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)

***

Expand All @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Loading