Skip to content

Commit 1f95769

Browse files
committed
improve documentation; correctly handle empty zoom auth
1 parent 47ab34a commit 1f95769

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

docs/providers/documentation/zoom_chat-provider.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ This channel will be the recipient of the Keep notifications.
4141

4242
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.
4343

44+
<Tip>
45+
You should use the "Full Format" Incoming Webhook Url, which ends in `?format=full`.
46+
</Tip>
47+
4448
<Frame width="100" height="200">
4549
<img height="10" src="/images/zoom_chat-provider5.png" />
4650
</Frame>
@@ -49,9 +53,9 @@ Send `/inc connect <connection name>` to the channel to enable a webhook with au
4953
<img height="10" src="/images/zoom_chat-provider6.png" />
5054
</Frame>
5155

52-
## Enabling User JID Lookup (Optional)
56+
## (Optional) Enabling User JID Lookup
5357

54-
Messages can optionally include Zoom user JIDs, which provide a way to tag a particular Zoom user in a message.
58+
Messages can optionally include Zoom user JIDs, which are used to tag a particular Zoom user in a message.
5559
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.
5660

5761
### Create a Zoom Application

docs/snippets/providers/zoom_chat-snippet-autogenerated.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Do not edit it manually, as it will be overwritten */}
33

44
## Authentication
55
This provider requires authentication.
6-
- **webhook_url**: Zoom Incoming Webhook Url (required: True, sensitive: True)
6+
- **webhook_url**: Zoom Incoming Webhook Full Format Url (required: True, sensitive: True)
77
- **authorization_token**: Incoming Webhook Authorization Token (required: True, sensitive: True)
88
- **account_id**: Zoom Account ID (required: False, sensitive: True)
99
- **client_id**: Zoom Client ID (required: False, sensitive: True)

keep/providers/zoom_chat_provider/zoom_chat_provider.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class ZoomChatProviderAuthConfig:
2828
webhook_url: HttpsUrl = dataclasses.field(
2929
metadata={
3030
"name": "webhook_url",
31-
"description": "Zoom Incoming Webhook Url",
31+
"description": "Zoom Incoming Webhook Full Format Url",
3232
"required": True,
3333
"sensitive": True,
3434
"validation": "https_url",
@@ -42,21 +42,24 @@ class ZoomChatProviderAuthConfig:
4242
"sensitive": True,
4343
},
4444
)
45-
account_id: str = dataclasses.field(
45+
account_id: Optional[str] = dataclasses.field(
46+
default="zoom_account_id",
4647
metadata={
4748
"required": False,
4849
"description": "Zoom Account ID",
4950
"sensitive": True,
5051
}
5152
)
52-
client_id: str = dataclasses.field(
53+
client_id: Optional[str] = dataclasses.field(
54+
default="zoom_client_id",
5355
metadata={
5456
"required": False,
5557
"description": "Zoom Client ID",
5658
"sensitive": True,
5759
}
5860
)
59-
client_secret: str = dataclasses.field(
61+
client_secret: Optional[str] = dataclasses.field(
62+
default="zoom_client_secret",
6063
metadata={
6164
"required": False,
6265
"description": "Zoom Client Secret",

0 commit comments

Comments
 (0)