Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 3.79 KB

README.md

File metadata and controls

46 lines (38 loc) · 3.79 KB
Raw

Zulip Send Message Action

This action sends a message to Zulip.

Inputs

Name Required? Details
api-key Yes API key used to interact with the Zulip API. You can get an API key through Zulip's web interface. You should store the API key as a secret.
content Yes The content of the message, formatted using Zulip Markdown. Maximum message size of 10000 bytes.
email Yes Email address of the user who owns the API key mentioned above. If using a bot, this should be the bot's email address, not the owning user's!
organization-url Yes Zulip organization canonical URL.
to Yes 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.
topic If type="stream" The topic of the message. Maximum length of 60 characters. Ignored if type="private".
type Yes The type of message to be sent. Must be either private, for a private message, or stream, for a stream message.

Example usage

Send a stream message

- name: Send a stream message
  uses: zulip/github-actions-zulip/send-message@v1
  with:
    api-key: ${{ secrets.ZULIP_API_KEY }}
    email: "username@example.com"
    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: zulip/github-actions-zulip/send-message@v1
  with:
    api-key: ${{ secrets.ZULIP_API_KEY }}
    email: "username@example.com"
    organization-url: "https://org.zulipchat.com"
    to: "9" # user_id
    type: "private"
    content: "With mirth and laughter let old wrinkles come."