github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_flock (markdown)

master
Chris Caron 2019-03-18 12:10:16 -04:00
parent 7fa4d5b592
commit d9b2ddae1d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Notify_flock.md

@ -28,12 +28,12 @@ Valid syntaxes with an *incoming webhook* are:
Valid syntaxes with an *application / bot* are: Valid syntaxes with an *application / bot* are:
**Note:** the **userid** and **channelid** belong to the actual encoded id and not the public displayed value. For instance; if you have a channel called #general, it will have an encoded id associated with it that might look something like **g:abcd1234defg**. Users are identified in a similar fashion but are prefixed with **u:** instead of **g:**. These are the values you must specify here: **Note:** the **userid** and **channelid** belong to the actual encoded id and not the public displayed value. For instance; if you have a channel called #general, it will have an encoded id associated with it that might look something like **g:abcd1234defg**. Users are identified in a similar fashion but are prefixed with **u:** instead of **g:**. These are the values you must specify here:
* flock://**{token}**/**u:userid** * flock://**{token}**/**u:userid**
* flock://**{botname}**@**{token}**/**u:userid** * flock://**{botname}**@**{token}**/**u:{user}**
* flock://**{botname}**@**{token}**/**u:user1id**/**u:user2id**/**u:userNid**/ * flock://**{botname}**@**{token}**/**u:{user1}**/**u:{user2}**/**u:{userN}**/
* flock://**{botname}**@**{token}**/**g:channelid** * flock://**{botname}**@**{token}**/**g:{channel}**
* flock://**{token}**/**g:channelid** * flock://**{token}**/**g:{channel}**
* flock://**{botname}**@**{token}**/**g:channel1id**/**g:channel2id**/**g:channelNid**/ * flock://**{botname}**@**{token}**/**g:{channel1}**/**g:{channel2}**/**g:{channelN}**/
* flock://**{botname}**@**{token}**/**g:channel1id**/**u:user1id**/ * flock://**{botname}**@**{token}**/**g:{channel}**/**u:{user}**/
### Parameter Breakdown ### Parameter Breakdown
@ -41,7 +41,7 @@ Valid syntaxes with an *application / bot* are:
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| token | Yes | The first part of 3 tokens provided to you after creating a *incoming-webhook* and or an *application/bot* | token | Yes | The first part of 3 tokens provided to you after creating a *incoming-webhook* and or an *application/bot*
| channel | No | Channels must be prefixed with a hash tag **#** or **g:**. They must represent the encoded id of the channel name (not the human readable reference) You can specify as many channels as you want by delimiting each of them by a forward slash (/) in the url. | channel | No | Channels must be prefixed with a hash tag **#** or **g:**. They must represent the encoded id of the channel name (not the human readable reference) You can specify as many channels as you want by delimiting each of them by a forward slash (/) in the url.
| user_id | No | Users must be prefixed with an at symbol **@** or **u:**! They must represent the encoded id of the user name (not the human readable reference) You can specify as many users as you want by delimiting each of them by a forward slash (/) in the url. | user | No | Users must be prefixed with an at symbol **@** or **u:**! They must represent the encoded id of the user name (not the human readable reference) 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*). | 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 #### Example