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.

Cisco Spark Notifier

sparkSend: Send spark message

Spark Notifier Plugin sends messages to spark spaces

Make sure you add the correct bot or user to the space
  • message
    Define the message to send to spark space

    Environment variable examples:
    • $BUILD_URL
    • ${BUILD_URL}
    • ${env.BUILD_URL}
    Commonly used variables:
    • ${JOB_NAME}
    • ${JOB_URL}
    • ${BUILD_NUMBER}
    • ${BUILD_URL}
    • ${BUILD_DISPLAY_NAME}
    • ${BUILD_ID}
    • ${BUILD_TAG}
    • ${JAVA_HOME}
    • ${JAVA_VERSION}
    • ${JENKINS_URL}
    • ${JENKINS_VERSION}
    • ${NODE_LABELS}
    • ${NODE_NAME}
    • ${PATH}
    • ${PWD}
    • ${EXECUTOR_NUMBER}
    if using SCM or SCM trigger (see the corresponding plugin wiki for additional environment variables):
    • ${BRANCH_NAME}
    • ${CHANGE_ID}
    • ${CHANGE_URL}
    • ${CHANGE_TITLE}
    • ${CHANGE_AUTHOR}
    • ${CHANGE_AUTHOR_DISPLAY_NAME}
    • ${CHANGE_AUTHOR_EMAIL}
    • ${CHANGE_TARGET}
    Environment variables injected into the step from withEnv and withCredentials can also be used
    • Type: String
  • spaceList
    To get the Space ID, go to web.ciscospark.com, select the space you want to message and get the ID from the URL.

    Example: https://web.ciscospark.com/#/rooms/f2fbc1f0-317c-11e6-8308-f3bee39e57c5
    The Space ID would be: f2fbc1f0-317c-11e6-8308-f3bee39e57c5


    You can also use the room ID representation acquired from GET https://api.ciscospark.com/v1/rooms

    See https://developer.ciscospark.com/endpoint-rooms-get.html for more information
      Array/List
      Nested Object
    • spaceName
      • Type: String
    • spaceId
      • Type: String
  • credentialsId
    • Type: String
  • disable (optional)
    • Type: boolean
  • failOnError (optional)
    • Type: boolean
  • messageType (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.