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
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,8 +467,6 @@
Ntfy.sh
</a>
</td>
</tr>
<tr>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/pushover-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/pushover-icon.png" alt="Pushover"/><br/>
Expand All @@ -481,6 +479,8 @@
Resend
</a>
</td>
</tr>
<tr>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/sendgrid-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/sendgrid-icon.png" alt="SendGrid"/><br/>
Expand All @@ -499,6 +499,18 @@
SMTP
</a>
</td>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/telegram-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/telegram-icon.png" alt="Telegram"/><br/>
Telegram
</a>
</td>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/twilio-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/twilio-icon.png" alt="Twilio"/><br/>
Twilio
</a>
</td>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/teams-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/teams-icon.png" alt="Teams"/><br/>
Expand All @@ -507,22 +519,16 @@
</td>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/zoom-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/zoom-icon.png" alt="Teams"/><br/>
<img width="40" src="keep-ui/public/icons/zoom-icon.png" alt="Zoom"/><br/>
Zoom
</a>
</td>
</tr>
<tr>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/telegram-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/telegram-icon.png" alt="Telegram"/><br/>
Telegram
</a>
</td>
<td align="center" width="150">
<a href="https://docs.keephq.dev/providers/documentation/twilio-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/twilio-icon.png" alt="Twilio"/><br/>
Twilio
<a href="https://docs.keephq.dev/providers/documentation/zoom_chat-provider" target="_blank">
<img width="40" src="keep-ui/public/icons/zoom-icon.png" alt="Zoom Chat"/><br/>
Zoom Chat
</a>
</td>
</tr>
Expand Down
Binary file added docs/images/zoom_chat-provider1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/zoom_chat-provider9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@
"providers/documentation/youtrack-provider",
"providers/documentation/zabbix-provider",
"providers/documentation/zenduty-provider",
"providers/documentation/zoom-provider"
"providers/documentation/zoom-provider",
"providers/documentation/zoom_chat-provider"
]
},
"providers/adding-a-new-provider"
Expand Down
82 changes: 82 additions & 0 deletions docs/providers/documentation/zoom_chat-provider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: "Zoom Chat"
sidebarTitle: "Zoom Chat Provider"
description: "Zoom Chat provider allows you to send Zoom Chats using the Incoming Webhook Zoom application."
---
import AutoGeneratedSnippet from '/snippets/providers/zoom_chat-snippet-autogenerated.mdx';

<Tip>
For this integration, you will need to add and configure the Incoming Webhook application from the Zoom App Marketplace: https://marketplace.zoom.us/apps/eH_dLuquRd-VYcOsNGy-hQ
</Tip>

<AutoGeneratedSnippet />

## Connecting with the Provider

### Enable the Incoming Webhook Application

The Incoming Webhook application is available in the Zoom App Marketplace.

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider1.png" />
</Frame>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider2.png" />
</Frame>

### Create Team Chat Channel:

This channel will be the recipient of the Keep notifications.

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider3.png" />
</Frame>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider4.png" />
</Frame>

### Enable the Incoming Webhook Application

Send `/inc connect <connection name>` to the channel to enable a webhook with authorization code. The app will respond with the webhook url and authorization code.

<Tip>
You should use the "Full Format" Incoming Webhook Url, which ends in `?format=full`.
</Tip>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider5.png" />
</Frame>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider6.png" />
</Frame>

## (Optional) Enabling User JID Lookup

Messages can optionally include Zoom user JIDs, which are used to tag a particular Zoom user in a message.
This is useful, for example, if a team subscribes to a chat channel but members only wish to be notified when they are explicitly tagged.

### Create a Zoom Application

User lookup requires authorization. Create an internal only, Zoom Server to Server OAuth application.

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider7.png" />
</Frame>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider8.png" />
</Frame>

### Assign Required Scopes

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider9.png" />
</Frame>

<Frame width="100" height="200">
<img height="10" src="/images/zoom_chat-provider10.png" />
</Frame>

1 change: 1 addition & 0 deletions docs/providers/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,4 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
- [Zabbix](/providers/documentation/zabbix-provider)
- [Zenduty](/providers/documentation/zenduty-provider)
- [Zoom](/providers/documentation/zoom-provider)
- [Zoom Chat](/providers/documentation/zoom_chat-provider)
7 changes: 7 additions & 0 deletions docs/providers/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -976,3 +976,10 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
icon={ <img src="https://img.logo.dev/zoom.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" /> }
></Card>
</CardGroup>

<Card
title="Zoom Chat"
href="/providers/documentation/zoom_chat-provider"
icon={ <img src="https://img.logo.dev/zoom.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" /> }
></Card>
</CardGroup>
42 changes: 42 additions & 0 deletions docs/snippets/providers/zoom_chat-snippet-autogenerated.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{/* This snippet is automatically generated using scripts/docs_render_provider_snippets.py
Do not edit it manually, as it will be overwritten */}

## Authentication
This provider requires authentication.
- **webhook_url**: Zoom Incoming Webhook Full Format Url (required: True, sensitive: True)
- **authorization_token**: Incoming Webhook Authorization Token (required: True, sensitive: True)
- **account_id**: Zoom Account ID (required: False, sensitive: True)
- **client_id**: Zoom Client ID (required: False, sensitive: True)
- **client_secret**: Zoom Client Secret (required: False, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:
- **user:read:user:admin**: View a Zoom user's details
- **user:read:list_users:admin**: List Zoom users



## In workflows

This provider can be used in workflows.



As "action" to make changes or update data, example:
```yaml
actions:
- name: Query zoom_chat
provider: zoom_chat
config: "{{ provider.my_provider_name }}"
with:
severity: {value} # The severity of the alert.
title: {value} # The title to use for the message. (optional)
message: {value} # The text message to send. Supports Markdown formatting.
tagged_users: {value} # A list of Zoom user email addresses to tag. (optional)
details_url: {value} # A URL linking to more information. (optional)
```




Check the following workflow example:
- [zoom_chat_example.yml](https://github.com/keephq/keep/blob/main/examples/workflows/zoom_chat_example.yml)
17 changes: 17 additions & 0 deletions examples/workflows/zoom_chat_example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
workflow:
id: zoom_chat-message
name: Zoom Chat Message
description: Sends a notification to a Zoom Chat channel via the Incoming Webhook application.
triggers:
- type: manual
actions:
- name: zoom_chat-action
provider:
type: zoom_chat
config: "{{ providers.zoom_chat }}"
with:
message: test message from keep
severity: critical
title: critical test message
tagged_users: joesmith@mail.com
details_url: https://www.github.com/keep
Binary file added keep-ui/public/icons/zoom_chat-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
Loading