diff --git a/Notify_stride.md b/Notify_stride.md new file mode 100644 index 0000000..a0c6d04 --- /dev/null +++ b/Notify_stride.md @@ -0,0 +1,36 @@ +## Stride Notifications +* **Source**: https://www.stride.com/ +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: 2000 Characters per message + +### Account Setup +Stride is the successor to Hipchat. It requires you to create a custom app and assign it to your channel you create. + +Let's start from the beginning: +1. When you sign-up with stride.com, the site will ask if you want to join a group or creating your own. Brand new users will start their own while companies might have already formed a group you want to join. +2. Once you get set up, you'll have the option of creating a channel (or if you joined your companies group, you might already see channels you can join in front of you). Either way, you need to be in a channel before you get to the next step. +3. Once you're in a channel you'll want to connect _apprise_ (this notification service) up. To do this, you need to go to the App Manager (on right hand side in your browser) an choose to '_Connect your own app_'. + * It will ask you to provide a '_token name_' which can be whatever you want. This will be used for reference later. Click the _Create_ button when you're done. + * When it completes it will generate a token that looks something like:
```HQFtq4pF8rKFOlKTm9Th```
This is important and we'll referenced it as your **{auth_token}**. + * If you scroll down it will also generate you a conversation URL that might look like:
```https://api.atlassian.com/site/ce171c45-09ae-4fac-a73d-5a4b7a322872/conversation/a54a80b3-eaad-4524-9a3a-f6653bcfb100/message```
Think of this URL like this:
```https://api.atlassian.com/site/{cloud_id}/conversation/{convo_id}/message```. Specifically pay close attention to the **{cloud_id}** and **{convo_id}** because you will need this to build your custom URL with. + +### Syntax +The valid syntax is as follows: +* **stride**://**{auth_token}**/**{cloud_id}**/**{convo_id}** + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| auth_token | Yes | The Authorization token that is created for you once you create your Custom App (that you associate with your channel). +| cloud_id | Yes | This is extracted from the URL that is created for you when you create your Custom App (the same one that is identified above).
**Note**: This is the first part of the conversation URL:
https\:\/\/api.atlassian.com/site/**{cloud_id}**/conversation/{convo_id}/message +| convo_id | Yes | This is extracted from the URL that is created for you when you create your Custom App (the same one that is identified above).
**Note**: This is the second part of the conversation URL:
https\:\/\/api.atlassian.com/site/{cloud_id}/conversation/**{convo_id}**/message + +#### Example +Send a stride notification: +```bash +# Assuming our {auth_token} is HQFtq4pF8rKFOlKTm9Th +# Assuming our {cloud_id} is ce171c45-09ae-4fac-a73d-5a4b7a322872 +# Assuming our {convo_id} is a54a80b3-eaad-4524-9a3a-f6653bcfb100 +notify stride://HQFtq4pF8rKFOlKTm9Th/ce171c45-09ae-4fac-a73d-5a4b7a322872/a54a80b3-eaad-4524-9a3a-f6653bcfb100 +``` \ No newline at end of file