Connectors Reference
Twitter is an online social networking service that enables users to send and receive short messages called 'tweets'. Connect to Twitter to manage your tweets. You can perform various actions such as send tweet, search, view followers, etc.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
UserTimeline (string userName, [advanced][Optional]integer maxResults) |
Get user timeline |
|
Get home timeline |
|
|
Search tweets |
|
|
Followers (string userName, [advanced][Optional]integer maxResults) |
Get followers |
|
Get my followers |
|
|
Following (string userName, [advanced][Optional]integer maxResults) |
Get following |
|
Get my following |
|
|
Get user |
|
|
Post a tweet |
|
|
Retweet |
|
Name |
Summary |
|
When a new tweet is posted |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get user timeline
Description: This operation gets a list of the most recent tweets posted by a given user.
Syntax:
Twitter.UserTimeline (string userName, [advanced][Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userName |
string (User name) |
Twitter handle for the user. |
True |
|
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of tweets to return. |
False |
Returns:
Type:array of (TweetModel)
Summary: Get home timeline
Description: This operation gets the most recent tweets and re-tweets posted by me and my followers.
Syntax:
Twitter.HomeTimeline ([Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of tweets to return. |
False |
Returns:
Type:array of (TweetModel)
Summary: Search tweets
Description: This operation gets a list of relevant tweets matching the search query.
Syntax:
Twitter.SearchTweet (string searchQuery, [advanced][Optional]integer maxResults, [advanced][Optional]string sinceId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
searchQuery |
string (Search text) |
Search term like "happy hour", #haiku, from:@username, love OR hate. |
True |
|
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of tweets to return. |
False |
|
|
sinceId |
string (sinceId) |
Return tweets after the specified tweet ID. |
False |
Returns:
Type:array of (TweetModel)
Summary: Get followers
Description: This operation gets the list of users that follow a given user.
Syntax:
Twitter.Followers (string userName, [advanced][Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userName |
string (User name) |
Twitter handle for the user. |
True |
|
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of users to return. |
False |
Returns:
Type:array of (UserDetailsModel)
Summary: Get my followers
Description: This operation gets the list of users who are following me.
Syntax:
Twitter.MyFollowers ([Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of users to get. |
False |
Returns:
Type:array of (UserDetailsModel)
Summary: Get following
Description: The operation gets the list of people the given user follows.
Syntax:
Twitter.Following (string userName, [advanced][Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userName |
string (User name) |
Twitter handle for the user. |
True |
|
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of users to return. |
False |
Returns:
Type:array of (UserDetailsModel)
Summary: Get my following
Description: This operation gets the list of users that I am following.
Syntax:
Twitter.MyFollowing ([advanced][Optional]integer maxResults)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
maxResults |
integer(int32) (Maximum results) |
Maximum number of users to return. |
False |
Returns:
Type:array of (UserDetailsModel)
Summary: Get user
Description: This operation gets the profile details for a given user, such as user name, description, followers count, and more.
Syntax:
Twitter.User (string userName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userName |
string (User name) |
Twitter handle for the user. |
True |
Returns:
Type:UserDetailsModel
Description: Represents a user.
Summary: Post a tweet
Description: This operation posts a new tweet.
Syntax:
Twitter.Tweet ([Optional]string tweetText, [Optional]string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
tweetText |
string (Tweet text) |
Text to be posted. |
False |
|
|
body |
string(binary)
|
|
False |
Returns:
Type:TweetResponseModel
Description: Represents the response of a tweet post.
Summary: Retweet
Description: This operation retweets a tweet.
Syntax:
Twitter.Retweet (string tweetId, [Optional]boolean trimUser)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
tweetId |
string (Tweet id) |
Tweet to be retweeted. |
True |
|
|
trimUser |
boolean (Trim user) |
Boolean to indicate whether to trim user information. |
False |
Returns:
Type:TweetResponseModel
Description: Represents the response of a tweet post.
Summary: When a new tweet is posted
Description: This operation triggers a flow when a new tweet that matches a given search query is posted.
Syntax:
Twitter.OnNewTweet (string searchQuery)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
searchQuery |
string (Search text) |
Search term like "happy hour", #haiku, from:@username, love OR hate. |
True |
Returns:
Type:TriggerBatchResponse[TweetModel]
Description: Represents a wrapper object for batch trigger response
Summary:
Description: Represents an original tweet post.
Properties:
|
Name |
Type |
Summary |
|
TweetText |
string Original tweet text |
Text content of the original retrieved tweet |
|
TweetId |
string Original tweet id |
Id of the original tweet |
|
CreatedAt |
string Original tweet created at |
Time at which original tweet was posted |
|
CreatedAtIso |
string Original tweet created at |
Time at which original tweet was posted |
|
RetweetCount |
integer(int32) Original tweet retweet count |
Total number of re-tweets for this original tweet |
|
TweetedBy |
string Original tweet tweeted by |
User name of the person who posted the original tweet |
|
MediaUrls |
array of (string) Original tweet media urls |
Url of the media posted along with the original tweet |
|
TweetLanguageCode |
string Original tweet language |
Language code for the original tweet |
|
TweetInReplyToUserId |
string Original tweet in_reply_to_user_id |
User Id of the author of the tweet that the current original tweet is a reply to |
|
Favorited |
boolean Original tweet favorited |
Indicates whether the original tweet is marked as favorited |
|
UserMentions |
array of (OriginalTweetUserMentionsModel) Original tweet user mentions |
The list of user mentioned in the tweet |
|
UserDetails |
|
Represents a user who posted an original tweet |
Summary:
Description: Represents a user who posted an original tweet
Properties:
|
Name |
Type |
Summary |
|
FullName |
string Original tweet user full name |
Name of the user |
|
Location |
string Original tweet user Location |
Location of the user |
|
Id |
integer(int64) Original tweet user id |
Twitter id (handle) of the user |
|
UserName |
string Original tweet user name |
Screen name of the user |
|
FollowersCount |
integer(int64) Original tweet user followers count |
Number of followers |
|
Description |
string Original tweet user Description |
User description |
|
StatusesCount |
integer(int64) Original tweet user statuses count |
User status count |
|
FriendsCount |
integer(int64) Original tweet user friends count |
Number of friends |
|
FavouritesCount |
integer(int64) Original tweet user favourites count |
Number of tweets that the user has favorited |
|
ProfileImageUrl |
string Original tweet user profile image url |
Url of the profile image |
Summary:
Description: Represents a user mentioned in an original tweet.
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64) Original tweet mentioned user id |
Twitter id (handle) of the user |
|
FullName |
string Original tweet mentioned user full name |
Full name of the user |
|
UserName |
string Original tweet mentioned user name |
Screen name of the user |
Summary:
Description: Represents a wrapper object for batch trigger response
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TweetModel)
|
A list of the response objects |
Summary:
Description: Represents a tweet post.
Properties:
|
Name |
Type |
Summary |
|
TweetText |
string Tweet text |
Text content of the tweet |
|
TweetId |
string Tweet id |
Id of the tweet |
|
CreatedAt |
string Created at |
Time at which the tweet was posted |
|
CreatedAtIso |
string Created at |
Time at which the tweet was posted |
|
RetweetCount |
integer(int32) Retweet count |
Total number of re-tweets for the tweet |
|
TweetedBy |
string Tweeted by |
Name of the user who has posted the tweet |
|
MediaUrls |
array of (string) Media urls |
Url of the media posted along with the tweet |
|
TweetLanguageCode |
string Tweet language |
Language code of the tweet |
|
TweetInReplyToUserId |
string in_reply_to_user_id |
User Id of the author of the tweet that the current tweet is a reply to |
|
Favorited |
boolean
|
Indicates whether the tweet is marked as favorited or not |
|
UserMentions |
array of (UserMentionsModel) User mentions |
List of users mentioned in the tweet |
|
OriginalTweet |
|
Represents an original tweet post. |
|
UserDetails |
|
Represents a user. |
Summary:
Description: Represents the response of a tweet post.
Properties:
|
Name |
Type |
Summary |
|
TweetId |
string Tweet id |
ID of the tweet posted |
Summary:
Description: Represents a user.
Properties:
|
Name |
Type |
Summary |
|
FullName |
string Name |
Name of the user |
|
Location |
string Location |
Location of the user |
|
Id |
integer(int64) User id |
Twitter id (handle) of the user |
|
UserName |
string User name |
Screen name of the user |
|
FollowersCount |
integer(int64) Followers count |
Number of followers |
|
Description |
string Description |
User description |
|
StatusesCount |
integer(int64) Statuses count |
User status count |
|
FriendsCount |
integer(int64) Friends count |
Number of friends |
|
FavouritesCount |
integer(int64) Favourites count |
Number of tweets that the user has favorited |
|
ProfileImageUrl |
string Profile image url |
Url of the profile image |
Summary:
Description: Represents a user mentioned in a tweet.
Properties:
|
Name |
Type |
Summary |
|
Id |
integer(int64) Mentioned user id |
Twitter id (handle) of the user |
|
FullName |
string Mentioned user full name |
Full name of the user |
|
UserName |
string Mentioned user name |
Screen name of the user |