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

Updated Notify_twitter (markdown)

master
Chris Caron 2025-06-07 15:44:47 -04:00
parent 250695c7e5
commit e979c20f76
1 changed files with 94 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

126
Notify_twitter.md

@ -1,54 +1,96 @@
## Twitter Notifications ## Twitter (X) Notifications
* **Source**: https://twitter.com/ * **Source**: https://x.com/
* **Attachment Support**: Yes * **Attachment Support**: Yes
* **Icon Support**: No * **Icon Support**: No
* **Message Format**: Text * **Message Format**: Text
* **Message Limit**: 10000 Characters per message if a private DM otherwise public tweets are limited to 280 character. * **Message Limit**: 10000 Characters per message if a private DM otherwise public posts are limited to 280 character (up to 25000 characters for public posts if you subscribe to X Premium).
### Account Setup ### Account Setup
Twitter Direct Messages are 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: You need to register to X developer account at [developer.x.com](https://developer.x.com/en).
1. First off, you need to generate a Twitter App from [developer.twitter.com](https://developer.twitter.com/en/apps). It's through a Twitter App we will be able to send our DMs. X Direct Messages are 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:
2. Once you create the app, you'll need to **generate the Access Tokens**. This Is done from the "*Keys and Access Tokens*" Tab.<br/>![Immagine 2022-05-29 215909](https://user-images.githubusercontent.com/55278049/170889227-a593c2e4-901c-42b1-801f-2a8e6f6eee28.png)
3. If you need to post automatic tweets, send private messages you need to request high access on your application you can do it by accessing the **Elevated** section under the **Twitter API v2** section (on left menu). Twitter asks you to justify why you need it as long as you specify the purpose of your app in detail<br/>![Immagine 2022-05-29 221019](https://user-images.githubusercontent.com/55278049/170889548-ef64e746-9159-45ec-a763-74199e864964.png)<br/>For more information, please refer [here](https://developer.twitter.com/en/support/twitter-api/v2#:~:text=Can%20all%20Twitter%20API%20v2,not%20available%20at%20this%20time.).
You should now have 4 Tokens to work with at this point on this same page. #### If there are Project and App
* A Consumer Key When you registered to X developer account, you may have already created a default project and app. You can use this app and it's through an X App we will be able to send our DMs.
* A Consumer Secret
1. First off, you'll need to **regenerate the API Keys**. This is done by accessing the app name under **Projects & Apps** (on left menu), then under the **Consumer Keys** from the "*Keys and tokens*" Tab. Once generated, copy it to a safe place. This is **Consumer Keys**.<br/>![X Generate Tokens](https://room.taikun.blog/wp-content/uploads/2025/05/X-Generate-Tokens.png)
2. Next, grant the appropriate access permissions so that you can post or send DMs. After clicking on the app name under **Projects & Apps** (on left menu), click on **Set up** under the **User authentication settings** section.<br/>![X User authentication set up](https://room.taikun.blog/wp-content/uploads/2025/05/X-User-authentication-set-up.png)<br/>On the **User authentication settings** page, set the following
* **App permissions**\
Select **Read and write** if you want to post only. If you want to send DMs, select **Read and write and Direct message**.
* **Type of App**\
Select **Web App, Automated App or Bot**
* **App info**\
Enter any URL for **Callback URI / Redirect URL** and **Website URL**. If you are using Apprise to send posts or DMs, it doesn't matter what you enter.
Once you entered them all, click **Save**.
3. Lastly, you'll need to **regenerate the Access Tokens**. This is done under the **Authentication Tokens** from the "*Keys and tokens*" Tab. Once generated, copy it to a safe place.<br/>![X Generate Tokens](https://room.taikun.blog/wp-content/uploads/2025/05/X-Generate-Tokens.png)
#### If there is no Project and App
1. First off, you need to create a project and an X App (not Standalone apps) from [developer.x.com](https://developer.x.com/en/portal/projects-and-apps). It's through an X App we will be able to send our DMs.<br/>![X Create Project](https://room.taikun.blog/wp-content/uploads/2025/05/X-Create-Project.png)<br/>X asks you to justify why you need it as long as you specify the purpose of your app in detail.
2. Once you created the app, you'll see the **API Tokens** on the screen, so copy it to a safe place. This is **Consumer Keys**.<br/>![X App API Key](https://room.taikun.blog/wp-content/uploads/2025/05/X-App-API-Key.png)
3. Next, grant the appropriate access permissions so that you can post or send DMs. After clicking on the app name under **Projects & Apps** (on left menu), click on **Set up** under the **User authentication settings** section.<br/>![X User authentication set up](https://room.taikun.blog/wp-content/uploads/2025/05/X-User-authentication-set-up.png)<br/>On the **User authentication settings** page, set the following
* **App permissions**\
Select **Read and write** if you want to post only. If you want to send DMs, select **Read and write and Direct message**.
* **Type of App**\
Select **Web App, Automated App or Bot**
* **App info**\
Enter any URL for **Callback URI / Redirect URL** and **Website URL**. If you are using Apprise to send posts or DMs, it doesn't matter what you enter.
Once you entered them all, click **Save**.
4. Lastly, you'll need to **generate the Access Tokens**. This is done under the **Authentication Tokens** from the "*Keys and tokens*" Tab. Once generated, copy it to a safe place.<br/>![X Generate Tokens](https://room.taikun.blog/wp-content/uploads/2025/05/X-Generate-Tokens.png)
You should now have the following 4 tokens ready to use.
* A Consumer Key (An API Key)
* A Consumer Secret (An API Secret)
* An Access Token * An Access Token
* An Access Token Secret * An Access Token Secret
![image](https://user-images.githubusercontent.com/850374/159798092-33126194-eefb-4bca-80d0-7020f25cfe22.png) From here you're ready to go. You can post public posts or simply create DMs through the use of the `mode=` variable. By default Direct Messaging (DM) is used.
From here you're ready to go. You can post public tweets or simply create DMs through the use of the mode= variable. By default Direct Messaging (DM) is used.
### Syntax ### Syntax
Valid syntax is as follows: Valid syntax is as follows:
- `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
- `twitter://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
If you know the targets you wish to identify; they can be targeted by their Twitter Screen Name: * `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
- `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName}` * `twitter://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
- `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName1}/{ScreenName2}/{ScreenNameN}`
**Note** If no ScreenName is specified, then by default the Direct Message is sent to your own account. Or
* `x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
* `x://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}`
If you know the targets you wish to identify; they can be targeted by their X Screen Name:
* `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName}`
* `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName1}/{ScreenName2}/{ScreenNameN}`
Or
* `x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName}`
* `x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName1}/{ScreenName2}/{ScreenNameN}`
> [!NOTE]
> If no ScreenName is specified, then by default the Direct Message is sent to your own account.
A Public post can be referenced like so:
A Public tweet can be referenced like so:
* `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet` * `twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet`
* `x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| ScreenName | Yes | The UserID of your account such as *l2gnux* (if your id is @l2gnux). You must specify a {userid} *or* an {ownerid}. | ScreenName | Yes | The UserID of your account such as *l2gnux* (if your id is @l2gnux). You must specify a `{userid}` *or* an `{ownerid}`.
| ConsumerKey | Yes | The Consumer Key | ConsumerKey | Yes | The Consumer Key (API Key)
| ConsumerSecret | Yes | The Consumer Secret Key | ConsumerSecret | Yes | The Consumer Secret Key (API Secret Key)
| AccessToken | Yes | The Access Token; you would have had to generate this one from your Twitter App Configuration. | AccessToken | Yes | The Access Token; you would have had to generate this one from your X App Configuration.
| AccessSecret | Yes | The Access Secret; you would have had to generate this one from your Twitter App Configuration. | AccessSecret | Yes | The Access Secret; you would have had to generate this one from your X App Configuration.
| Mode | No | The Twitter mode you want to operate in. Possible values are **dm** (for Private Direct Messages) and **tweet** to make a public post. By default this is set to **dm** | Mode | No | The X mode you want to operate in. Possible values are `dm` (for Private Direct Messages) and `tweet` to make a public post. By default this is set to `dm`
| batch | No | By default images are batched together. However if you want your attachments to be posted 1 tweet per attachment, set this to False. | batch | No | By default images are batched together. However if you want your attachments to be posted 1 post per attachment, set this to False.
#### Example #### Example
Send a Twitter DM to @testaccount: Send a X DM to @testaccount:
```bash ```bash
# Assuming our {ConsumerKey} is T1JJ3T3L2 # Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD # Assuming our {ConsumerSecret} is A1BRTD4JD
@ -57,10 +99,22 @@ Send a Twitter DM to @testaccount:
# our user is @testaccount # our user is @testaccount
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3 twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3
``` ```
Send a public Tweet: Or
```bash
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
# our user is @testaccount
apprise -vv -t "Test Message Title" -b "Test Message Body" \
x://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3
```
Send a public post:
```bash ```bash
# Assuming our {ConsumerKey} is T1JJ3T3L2 # Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD # Assuming our {ConsumerSecret} is A1BRTD4JD
@ -68,5 +122,15 @@ Send a public Tweet:
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3 # Assuming our {AccessSecret} is FDVJaj4jcl8chG3
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet
```
Or
```bash
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
apprise -vv -t "Test Message Title" -b "Test Message Body" \
x://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet
``` ```