Git Product home page Git Product logo

github-actions-zulip's Introduction

Zulip Send Message Action

GitHub Action badge

This action sends a message to Zulip.

Inputs

api-key

Required API key used to interact with the Zulip API. You can get an API key through Zulip's web interface.

email

Required Email address of the user who owns the API key mentioned above.

organization-url

Required Zulip organization canonical URL.

to

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.

type

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.

topic

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

content

Required The content of the message. Maximum message size of 10000 bytes. Format your message using Zulip Markdown.

Example usage

Send a stream message

- name: Send a stream message
  uses: zulip/[email protected]
  with:
    api-key: 'abcd1234'
    email: '[email protected]'
    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/[email protected]
  with:
    api-key: 'abcd1234'
    email: '[email protected]'
    organization-url: 'https://org.zulipchat.com'
    to: '9' # user_id
    type: 'private'
    content: 'With mirth and laughter let old wrinkles come.'

github-actions-zulip's People

Contributors

ggrossetie avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.