Tokens

Tokens types

String

Template: [GROUP:PROPERTY].

Boolean

Template: [GROUP:PROPERTY|<TEXT IF TRUE>|<TEXT IF FALSE>].

Date

Template: [GROUP:PROPERTY|<FORMAT>]. For format allowed use any letters from php date function.

Collection

Template: [GROUP:PROPERTY|<SEPARATOR>|<FILTER>]<RENDERED STRING FOR EVERY ITEM OF THE COLLECTION>[/GROUP:PROPERTY].

Add several filter properties using plus (+).

Tokens

Task

Token Type Example Result
[task:id] string [task:id] 123
[task:status] string [task:status] new_updates_available
[task:branch] string [task:branch] master
[task:update-from-vulnerable-version] boolean [task:update-from-vulnerable-version|yes|no] yes
[task:updated-at] date [task:updated-at|d-m-Y-H-i-s], [task:updated-at|U] 17-12-2018-12-32-12, 1538937477334
[task:created-at] date [task:created-at|d-m-Y-H-i-s], [task:created-at|U] 17-12-2018-12-32-12, 1538937477334
[task:url] string [task:url] https://app.codario.io/projects/xxx/tasks/xxx
[task:packages] collection [task:packages|,|main+sub+with_vulnerabilities+without_vulnerabilities][package:name]: [package:current-version] -> [package:new-version][/task:packages] vendor/a: 1.2.3 -> 1.2.4,vendor/b: 1.7.3 -> 1.8.2

For the [task:packages] token you use the following filter properties:

  • main — get "main" packages (specified in a manifest file)
  • sub — get "subpackages" (dependencies from "main" packages)
  • with_vulnerabilities — get packages with vulnerabilities
  • without_vulnerabilities — get packages without vulnerabilities

For example:

  • to get all main packages use: main+with_vulnerabilities+without_vulnerabilities
  • to get all sub packages without vulnerabilities use: sub+without_vulnerabilities
  • to get all packages use: main+sub+with_vulnerabilities+without_vulnerabilities or just use empty value for the filter.

Packages

Available only inside [task:packages].

Token Type Example Result
[package:name] string [package:name] vendor/a
[package:path] string [package:path] composer.lock
[package:current-version] string [package:current-version] 1.2.3
[package:new-version] string [package:new-version] 1.2.4
[package:update-from-vulnerable-version] boolean [package:update-from-vulnerable-version|yes|no] yes
[package:is-applied] boolean [package:is-applied] yes
[package:created-at] date [package:created-at|d-m-Y-H-i-s], [package:created-at|U] 17-12-2018-12-32-12, 1538937477334

Project

Token Type Example Result
[project:id] string [project:id] 1
[project:name] string [project:name] Project A
[project:manager] string [project:manager] composer
[project:git-path] string [project:git-path] git@host:repo.git
[project:main-branch] string [project:main-branch] master
[project:root-folder] string [project:root-folder] app
[project:created-at] date [project:created-at|d-m-Y-H-i-s], [project:created-at|U] 17-12-2018-12-32-12, 1538937477334
[project:url] string [project:url] https://app.codario.io/projects/xxx
[project:integration:pm] string [project:integration:pm] my_jira_system
[project:integration:collaboration] string [project:integration:collaboration] my_slack
[project:integration:cicd] string [project:integration:cicd] ssh.server-1

User

Token Type Example Result
[user:email] string [user:email] user@email.com
[user:name] string [user:name] John Smit
[user:company] string [user:company] My company
[user:timezone] string [user:timezone] UTC+0
[user:created-at] date [user:created-at|d-m-Y-H-i-s], [user:created-at|U] 17-12-2018-12-32-12, 1538937477334

Date

Token Type Example Result
[date:current] date [date:current|d-m-Y-H-i-s], [date:current|U] 17-12-2018-12-32-12, 1538937477334