> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

RocketChat Notifier

View this plugin on the Plugins site

rocketSend: Send RocketChat Message

Simple step for sending a RocketChat message to specified channel.
Use the advanced settings to override the RocketChat Plugin global configuration to include: channel.
Please see the RocketChat Plugin global configuration for more details on the fields. Usage Example:
rocketSend "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
  • message
    • Type: String
  • attachments (optional)
      Array / List of Nested Object
    • title
      • Type: String
    • audioUrl (optional)
      • Type: String
    • authorIcon (optional)
      • Type: String
    • authorName (optional)
      • Type: String
    • collapsed (optional)
      • Type: boolean
    • color (optional)
      • Type: String
    • imageUrl (optional)
      • Type: String
    • messageLink (optional)
      • Type: String
    • text (optional)
      • Type: String
    • thumbUrl (optional)
      • Type: String
    • titleLink (optional)
      • Type: String
    • titleLinkDownload (optional)
      • Type: boolean
    • ts (optional)
      • Type: String
    • videoUrl (optional)
      • Type: String
  • avatar (optional)
    • Type: String
  • channel (optional)
    • Type: String
  • color (optional)
    • Type: String
  • emoji (optional)
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • rawMessage (optional)
    • Type: boolean
  • serverUrl (optional)
    • Type: String
  • trustSSL (optional)
    • Type: boolean
  • useGlobalWebhookToken (optional)
    • Type: boolean
  • webhookToken (optional)
    • Type: String
  • webhookTokenCredentialId (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.