github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: Notify_twitter
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_bluesky Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chanify Notify_clickatell Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_jira Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_lark Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushplus Notify_pushsafer Notify_pushy Notify_qq Notify_reddit Notify_resend Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_spugpush Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
15 Notify_twitter
Chris Caron edited this page 2025-06-07 15:44:47 -04:00
Table of Contents

Twitter (X) Notifications

  • Source: https://x.com/
  • Attachment Support: Yes
  • Icon Support: No
  • Message Format: Text
  • 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

You need to register to X developer account at developer.x.com.

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:

If there are Project and App

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.

  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.
    X Generate Tokens

  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.
    X User authentication set up
    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.
    X Generate Tokens

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. It's through an X App we will be able to send our DMs.
    X Create Project
    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.
    X App API Key

  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.
    X User authentication set up
    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.
    X Generate Tokens

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 Secret

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.

Syntax

Valid syntax is as follows:

  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}
  • twitter://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}

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:

  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet
  • x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet

Parameter Breakdown

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}.
ConsumerKey Yes The Consumer Key (API 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 X App Configuration.
AccessSecret Yes The Access Secret; you would have had to generate this one from your X App Configuration.
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 post per attachment, set this to False.

Example

Send a X DM to @testaccount:

# 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" \
   twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3

Or

# 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:

# 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" \
   twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet

Or

# 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

Quick Links: