Contents
Specific SIL integrations
Predefined structures for a Stride message
Name | Field | Type |
---|---|---|
JStrideMessage | version | number |
type | string | |
content | JStrideContent[] | |
JStrideContent | type | string |
text | string | |
content | JStrideContent[] | |
marks | JStrideMarks[] | |
attrs | JStrideAttrs | |
JStrideMarks | type | string |
attrs | JStrideAttrs | |
JStrideAttrs | id | string |
localId | string | |
state | string | |
panelType | string | |
href | string | |
title | string | |
color | string | |
type | string | |
text | string | |
shortName | string |
Predefined structures for a Slack message
Name | Field | Type |
---|---|---|
JSlackMessage | channel | string |
text | string | |
attachments | JSlackAttachment[] | |
JSlackAttachment | pretext | string |
fallback | string | |
title | string | |
title_link | string | |
text | string | |
color | string |
Configuring an integration
To do this, you must have Administrator permissions.
General setup
To configure an integration, perform the following actions:
- In your Jira, go to Manage add-ons > cPrime Plugin Configuration > Integration Configurations, and click Add Integration.
- Fill in the necessary fields:
- Name - the name of the integration, it should be unique from other integrations
- Type - the integration type
- Access token
- Conversation URL - you need to specify this for Stride integration only
- Save the integration. After saving the added integration, a new entry is added to the table on the Integration Configurations page.
To edit or remove a configuration, click Edit/Delete.
Configuring notifications to go from Jira to Stride
In order to send a message to a Stride room, add an integration on the Integration Configurations page. To generate an access token and a conversation URL you have to:
- Go to Stride and select your room.
- Open the Apps sidebar, click "+" > Add custom app > API tokens, and specify the app name.
- Copy conversation URL and an access token.
- Insert these to the corresponding fields on the Integration Configurations page.
Now your configuration is ready to be used in a script.
Configuring notifications to go from Jira to Slack
In order to send a message to a Slack room, add an integration configuration on the Integration Configurations page. The access token can be a bot, a workspace, or a user token. If you want to create a bot for your workspace, perform the following steps:
- Navigate to the Bots page in the Slack App Directory.
- Click Add Configuration.
- Choose a username for your bot and add the bot integration.
- Copy the access token to the Integration Configurations page and Save.
Now your configuration is ready to be used in a script.
You can read more about how to create/regenerate tokens for Slack here.
Examples
Send a message to Slack when a ticket is created
To send a message to Slack when an issue is created, add a post-function on the create transition in Jira with the following code:
JSlackAttachment issue; issue.pretext = key.reporter + " created:"; issue.title = key; issue.title_link =getIssueURL(key); issue.text = key.summary; JSlackMessage message; message.channel = "C94S1U658"; // Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name message.attachments = {issue}; return sendIntegrationMessage("SLACK", message);
Here's an example of how such notification can look like in Slack.
Send a message to Stride when an issue is created
To send a message to Stride when an issue is created, add a post-function on the create transition in Jira with the following code:
JStrideContent reporter; reporter.type = "text"; reporter.text = key.reporter + "created "; JStrideAttrs attrs; attrs.href = getIssueURL(key); attrs.title = key; JStrideMarks link; link.type = "link"; link.attrs = attrs; JStrideContent issueKey; issueKey.type = "text"; issueKey.marks = {link}; issueKey.text = key; JStrideContent summary; summary.type = "text"; summary.text = " : " + key.summary; JStrideContent paragraph; paragraph.type = "paragraph"; paragraph.content = {reporter, issueKey, summary}; JStrideMessage message; message.version = 1; message.type = "doc"; message.content = {paragraph}; return sendIntegrationMessage("PS", message);
Here's an example of how such notification can look like in Stride.
See also
sendIntegrationMessage — Sends a message to integration.