This action sends a message to Zulip.

Required Username used to interact with the Zulip API.

Optional API key used to interact with the Zulip API. Only required if password is not defined.

Optional Password used to interact with the Zulip API. Only required if api-key is not defined, ignored otherwise.

Required Zulip organization canonical URL.

Required For stream messages, either the name or integer ID of the stream. For private messages, either a list containing integer user IDs or a list containing string email addresses.

Required The type of message to be sent. private for a private message and stream for a stream message. Must be one of: private, stream.

Optional The topic of the message. Only required for stream messages (type="stream"), ignored otherwise. Maximum length of 60 characters.

Required The content of the message. Maximum message size of 10000 bytes.

Send a stream message

- name: Send a stream message
  uses: yuzutech/zulip-send-message-action@main
  with:
    username: 'username@example.com'
    api-key: 'abcd1234'
    organization-url: 'https://org.zulipchat.com'
    to: 'social'
    type: 'stream'
    topic: 'Castle'
    content: 'I come not, friends, to steal away your hearts.'

Send a private message

- name: Send a private message
  uses: yuzutech/zulip-send-message-action@main
  with:
    username: 'username@example.com'
    api-key: 'abcd1234'
    organization-url: 'https://org.zulipchat.com'
    to: '9' # user_id
    type: 'private'
    content: 'With mirth and laughter let old wrinkles come.'