mirror of
https://github.com/caronc/apprise.git
synced 2024-12-13 10:21:51 +01:00
Updated Notify_slack (markdown)
Chris Caron
parent
5c796b2b07
commit
d302414bf7
@ -3,11 +3,12 @@
|
||||
* **Icon Support**: Yes
|
||||
* **Attachment Support**: Yes
|
||||
* **Message Format**: Markdown
|
||||
* **Message Limit**: 1000 Characters per message
|
||||
* **Message Limit**: 30000 Characters per message
|
||||
|
||||
### Account Setup
|
||||
Slack is slightly more complicated then some of the other notification services, so here is quick breakdown of what you need to know and do in order to send Notifications through it using this tool:
|
||||
|
||||
#### Method 1: Incoming Webhook
|
||||
First off, Slack notifications require an *incoming-webhook* it can connect to.
|
||||
|
||||
1. You can create this webhook from [here](https://my.slack.com/services/new/incoming-webhook/). Just follow the wizard to pre-determine the channel(s) you want your message to broadcast to.
|
||||
@ -29,46 +30,66 @@ The last part of the URL you're given make up the 3 tokens you need to send noti
|
||||
2. **TokenB** is ```A1BRTD4JD```
|
||||
3. **TokenC** is ```TIiajkdnlazkcOXrIdevi7F8```
|
||||
|
||||
#### Method 2: Create a Bot
|
||||
Bots offer you slightly more flexibility then Webhooks do. The main difference is *Slack Bots* can support attachments allowing you to leverage this in Apprise!
|
||||
1. First create your [Slack App here](https://api.slack.com/apps?new_app=1).
|
||||
1. Pick an App Name (such as *Apprise*) and select your workspace; click on the **Create App**
|
||||
1. You'll be able to click on **Bots** menu selection from here where you can then choose to add a **Bot User**. Give it a name and then choose **Add Bot User*.
|
||||
1. Now choose **Install App** to which you can choose **Install App to Workspace**.
|
||||
1. You will need to authorize the app which you get prompted to do; so this step is easy.
|
||||
1. Finally you'll get some very important information you will need for Apprise. From this point on you can either used the **OAuth Access Token** or the **Bot User OAuth Access Token** using the syntax `slack://{OAuth Access Token}`.
|
||||
|
||||
Your Apprise Slack URL (for accessing your Bot) might look something like:
|
||||
- `slack://xoxp-1234-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d`
|
||||
- `slack://xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d`
|
||||
|
||||
Both OAuth tokens you are provided have the ability to post text to channels and provide attachments. So it's up to you which of the two you choose to use.
|
||||
|
||||
:rotating_light: :rotating_light: **Note:** Both Attachment and Slack Bot support are ONLY available from the **master** branch at this time. This is a very new enhancement. Bot support will appear officially in the next version (0.8.2) of Apprise.
|
||||
|
||||
### Syntax
|
||||
Valid syntaxes are as follows:
|
||||
* **slack**://**{tokenA}**/**{tokenB}**/**{tokenC}**
|
||||
* `slack://{tokenA}/{tokenB}/{tokenC}`
|
||||
* `https://hooks.slack.com/services/{tokenA}/{tokenB}/{tokenC}`
|
||||
* `slack://{OAuthToken}/`
|
||||
- A Bot has no default channel configurable through Slack like Webhooks do. If no channel is specified, then the channel `#general` is used.
|
||||
|
||||
Now if you're using the legacy webhook method (and not going through the App), you're granted a bit more freedom. As a result, the following URLs will also work for you through Apprise:
|
||||
* **slack**://**{tokenA}**/**{tokenB}**/**{tokenC}**/**#{channel}**
|
||||
* **slack**://**{tokenA}**/**{tokenB}**/**{tokenC}**/**#{channel1}**/**#{channel2}**/**#{channelN}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**#{channel}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**#{channel1}**/**#{channel2}**/**#{channelN}**
|
||||
* `slack://{tokenA}/{tokenB}/{tokenC}/#{channel}`
|
||||
* `slack://{tokenA}/{tokenB}/{tokenC}/#{channel1}/#{channel2}/#{channelN}`
|
||||
* `slack://{OAuthToken}/#{channel}`
|
||||
* `slack://{botname}@{OAuthToken}/#{channel1}/#{channel2}/#{channelN}`
|
||||
|
||||
If you know the *Encoded-ID* of the channel you wish to access, you can use the plus (+) symbol to identify these separately from channels in the url. Valid syntaxes are as follows:
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**+{encoded_id}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**+{encoded_id1}**/**+{encoded_id2}**/**+{encoded_id3}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**+{encoded_id}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**+{encoded_id1}**/**+{encoded_id2}**/**+{encoded_id3}**
|
||||
* `slack://{botname}@{tokenA}/{tokenB}/{tokenC}/+{encoded_id}`
|
||||
* `slack://{botname}@{tokenA}/{tokenB}/{tokenC}/+{encoded_id1}/+{encoded_id2}/+{encoded_id3}`
|
||||
* `slack://{botname}@{OAuthToken}/+{encoded_id}`
|
||||
* `slack://{botname}@{OAuthToken}/+{encoded_id1}/+{encoded_id2}/+{encoded_id3}`
|
||||
|
||||
If you know the user_id you wish to transmit your slack notification to (instead of a channel), you can use the at symbol (@) to do this with. Valid syntaxes are as follows:
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id1}**/**@{user_id2}**/**@{user_id3}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id1}**/**@{user_id2}**/**@{user_id3}**
|
||||
* `slack://{botname}@{tokenA}/{tokenB}/{tokenC}/@{user_id}`
|
||||
* `slack://{botname}@{tokenA}/{tokenB}/{tokenC}/@{user_id1}/@{user_id2}/@{user_id3}`
|
||||
* `slack://{botname}@{OAuthToken}/@{user_id}`
|
||||
* `slack://{botname}@{OAuthToken}/@{user_id1}/@{user_id2}/@{user_id3}`
|
||||
|
||||
You can freely mix and match all of the combinations in any order as well:
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id}**/**#{channel}**/**+{encoded_id}**
|
||||
* **slack**://**{botname}**@**{tokenA}**/**{tokenB}**/**{tokenC}**/**@{user_id}**/**#{channel}**/**+{encoded_id}**
|
||||
* `slack://**{botname}@{tokenA}/{tokenB}/{tokenC}/@{user_id}/#{channel}/+{encoded_id}`
|
||||
* `slack://{botname}@{OAuthToken}/@{user_id}/#{channel}/+{encoded_id}`
|
||||
|
||||
### Parameter Breakdown
|
||||
| Variable | Required | Description
|
||||
| ----------- | -------- | -----------
|
||||
| tokenA | Yes | The first part of 3 tokens provided to you after creating a *incoming-webhook*
|
||||
| tokenB | Yes | The second part of 3 tokens provided to you after creating a *incoming-webhook*
|
||||
| tokenC | Yes | The last part of 3 tokens provided to you after creating a *incoming-webhook*
|
||||
| tokenA | Yes | The first part of 3 tokens provided to you after creating a *incoming-webhook*. The OAuthToken is not required if using the Slack Webhook.
|
||||
| tokenB | Yes | The second part of 3 tokens provided to you after creating a *incoming-webhook*. The OAuthToken is not required if using the Slack Webhook.
|
||||
| tokenC | Yes | The last part of 3 tokens provided to you after creating a *incoming-webhook*. The OAuthToken is not required if using the Slack Webhook.
|
||||
| OAuthToken | Yes | The OAuth Token provided to you through the Slack App when using a a *Bot* instead of a Webhook. Token A, B and C are not used when using Bots.
|
||||
| channel | No | Channels must be prefixed with a hash tag **#**! You can specify as many channels as you want by delimiting each of them by a forward slash (/) in the url.
|
||||
| encoded_id | No | Slack allows you to represent channels and private channels by an *encoded_id*. If you know what they are, you can use this instead of the channel to send your notifications to. All encoded_id's must be prefixed with a plus symbol **+**!
|
||||
| user_id | No | Users must be prefixed with an at symbol **@**! You can specify as many users as you want by delimiting each of them by a forward slash (/) in the url.
|
||||
| botname | No | Identify the name of the bot that should issue the message. If one isn't specified then the default is to just use your account (associated with the *incoming-webhook*).
|
||||
|
||||
#### Example
|
||||
Send a slack notification to our channel #nuxref:
|
||||
Send a Slack notification to the channel `#nuxref`:
|
||||
```bash
|
||||
# Assuming our {tokenA} is T1JJ3T3L2
|
||||
# Assuming our {tokenB} is A1BRTD4JD
|
||||
@ -76,3 +97,10 @@ Send a slack notification to our channel #nuxref:
|
||||
# our channel nuxref is represented by #nuxref
|
||||
apprise slack:///T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/#nuxref
|
||||
```
|
||||
|
||||
Alternatively, if you're using the Bot; a Slack notification sent to the channel `#general` might look like this:
|
||||
```bash
|
||||
# Assuming our {OAuthToken} is xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d
|
||||
# our channel general is represented by #general
|
||||
apprise slack://xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d/#general
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user