
Zoom SendMessage
CertifiedSend a Zoom Team Chat message
Zoom SendMessage
Send a Zoom Team Chat message
Posts a message to a Zoom channel or a Zoom user via the Zoom Team Chat API.
type: io.kestra.plugin.zoom.SendMessageExamples
Notify a Zoom channel when a flow fails.
id: unreliable_flow
namespace: company.team
tasks:
- id: fail
type: io.kestra.plugin.scripts.shell.Commands
runner: PROCESS
commands:
- exit 1
errors:
- id: alert_on_failure
type: io.kestra.plugin.zoom.SendMessage
accountId: "{{ secret('ZOOM_ACCOUNT_ID') }}"
clientId: "{{ secret('ZOOM_CLIENT_ID') }}"
clientSecret: "{{ secret('ZOOM_CLIENT_SECRET') }}"
userId: "{{ secret('ZOOM_BOT_USER_ID') }}"
channel: "{{ secret('ZOOM_CHANNEL_ID') }}"
message: "Flow {{ flow.namespace }}.{{ flow.id }} failed."
Notify a Zoom channel when a flow completes successfully and store the message ID in the KV store.
id: notify_zoom_on_success
namespace: company.team
tasks:
- id: run_job
type: io.kestra.plugin.scripts.shell.Commands
runner: PROCESS
commands:
- echo "job done"
- id: send_notification
type: io.kestra.plugin.zoom.SendMessage
accountId: "{{ secret('ZOOM_ACCOUNT_ID') }}"
clientId: "{{ secret('ZOOM_CLIENT_ID') }}"
clientSecret: "{{ secret('ZOOM_CLIENT_SECRET') }}"
userId: "{{ secret('ZOOM_BOT_USER_ID') }}"
channel: "{{ secret('ZOOM_CHANNEL_ID') }}"
message: "Flow {{ flow.namespace }}.{{ flow.id }} completed successfully."
- id: store_message_id
type: io.kestra.plugin.core.kv.Set
key: last_zoom_message_id
value: "{{ outputs.send_notification.messageId }}"
Properties
accountId *string
Zoom Account ID
Account ID obtained from Zoom App Marketplace
clientId *string
Zoom Client ID
Client ID obtained from Zoom App Marketplace
clientSecret *string
Zoom Client Secret
Client Secret obtained from Zoom App Marketplace
message *string
Message
The message to send
userId *string
Zoom User ID
The Zoom user ID associated with the chat
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
Custom Base URL
Override Zoom API base URL. Defaults to https://api.zoom.us/v2/
channel string
Channel
The Zoom channel ID to send the message to
toContact string
Recipient Contact
The email address of the user to send the message to
Outputs
messageId string
The ID of the sent message
UUID of the Zoom Team Chat message, as returned by the Zoom API. Can be used by downstream tasks to reply to, update, or delete the message.