Zoom SendMessage

Zoom SendMessage

Certified

Send a Zoom Team Chat message

Posts a message to a Zoom channel or a Zoom user via the Zoom Team Chat API.

yaml
type: io.kestra.plugin.zoom.SendMessage

Notify a Zoom channel when a flow fails.

yaml
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.

yaml
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

Zoom Account ID

Account ID obtained from Zoom App Marketplace

Zoom Client ID

Client ID obtained from Zoom App Marketplace

Zoom Client Secret

Client Secret obtained from Zoom App Marketplace

Message

The message to send

Zoom User ID

The Zoom user ID associated with the chat

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Custom Base URL

Override Zoom API base URL. Defaults to https://api.zoom.us/v2/

Channel

The Zoom channel ID to send the message to

Recipient Contact

The email address of the user to send the message to

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.