Skip to content

Commit

Permalink
fix: update push channel docs for credentials
Browse files Browse the repository at this point in the history
  • Loading branch information
scopsy committed Sep 3, 2024
1 parent d4da243 commit db2cca3
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
23 changes: 9 additions & 14 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -167,20 +167,15 @@
"sdks/framework/typescript/overview",
"sdks/framework/typescript/client",
"sdks/framework/typescript/workflow",
{
"group": "Steps",
"pages": [
"sdks/framework/typescript/steps/introduction",
"sdks/framework/typescript/steps/email",
"sdks/framework/typescript/steps/inbox",
"sdks/framework/typescript/steps/sms",
"sdks/framework/typescript/steps/push",
"sdks/framework/typescript/steps/chat",
"sdks/framework/typescript/steps/digest",
"sdks/framework/typescript/steps/delay",
"sdks/framework/typescript/steps/custom"
]
}
"sdks/framework/typescript/steps/introduction",
"sdks/framework/typescript/steps/email",
"sdks/framework/typescript/steps/inbox",
"sdks/framework/typescript/steps/sms",
"sdks/framework/typescript/steps/push",
"sdks/framework/typescript/steps/chat",
"sdks/framework/typescript/steps/digest",
"sdks/framework/typescript/steps/delay",
"sdks/framework/typescript/steps/custom"
]
},
{
Expand Down
5 changes: 5 additions & 0 deletions sdks/framework/typescript/steps/chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ icon: "comments"

The `chat` step allows you to send a message to a chat channel. This is useful when you need to send a message to a chat channel, such as Slack, Discord, or Microsoft Teams.

### Push Credentials

In order to send a chat message, you need to set the specific chat provider credentials for the subscriber.
You can learn more about how to achieve this for each provider in the [Provider Documentation](/integrations/providers/chat/overview).

## Chat Output

<RequestExample>
Expand Down
5 changes: 5 additions & 0 deletions sdks/framework/typescript/steps/push.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ The `push` step allows you to send a message to a push channel. This is useful w
```
</RequestExample>

### Push Credentials

In order to send a push notification to a subscriber, you need to set the specific push provider credentials for the subscriber.
You can learn more about how to achieve this for each provider in the [Provider Documentation](/integrations/providers/push/overview).

## Push Output

<ParamField path="subject" type="string" required>
Expand Down

0 comments on commit db2cca3

Please sign in to comment.