Notification

Notification
Notification

Notifications are ways to communicate with your teams and let them know the status of your Pipelines in Code Stream.

JSON Example 
{
    "eventGroup": "COMPLETED",
    "jiraResponse": {
        "ID": "VRCS-23",
        "link": "/link/to/Jira/issue/VRCS-23"
    },
    "providerType": "Email/Slack/Jira",
    "responseCode": 200,
    "responseMessage": 200,
    "stage": "string",
    "success": true,
    "task": "string"
}
string
eventGroup
Optional

The event on which this Notification is triggered.

object
jiraResponse
Optional

Only for Jira. Contains the Jira issue ID for creating a ticket.

string
providerType
Optional

Mode of transmission of this Notification.

string
responseCode
Optional

Only for Jira/Webhook. Specifies any HTTP response code received from any REST calls related to the Notification.

string
responseMessage
Optional

Only for Jira/Webhook. Specifies any HTTP response message received from any REST calls related to the Notification.

string
stage
Optional

Stage that this Notification belongs to.

boolean
success
Optional

Flag that represents if the Notification was successfully posted or not.

string
task
Optional

Task that this Notification belongs to.

Property Of