App Vendor: Twitter
Connector Category: IT Service | Messaging
App Version in Orchestrate: 1.0.0
API Version: 2.0.0
About App
The Twitter app provides the capability to retrieve and analyze data, tap into millions of tweets to analyze and engage, and also look up twitter users to analyze the network and audience. The Twitter app allows security teams to connect to the Twitter account with a development profile and act on tweets, users, and timelines.
The Twitter app is configured with the Orchestrate application to perform the following actions:
Action | Description |
|---|---|
Tweet Search | This action performs a search using a query on Twitter. |
User Timeline Lookup | This action retrieves tweets from a user timeline. |
Multiple Tweet Lookup | This action retrieves details about multiple tweets. |
Tweet Lookup | This action retrieves details about a tweet. |
Search User By ID | This action performs a search for a specific user using the user ID. |
Search User By Name | This action retrieves details about a specific user using the username. |
Configuration Parameters
The following configuration parameters are required for the Twitter app to communicate with the Twitter enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Token | Enter the bearer token of the Twitter developer account. Example: "AAAAAAFnz2wAAAAAACOwLSPtVT5gxxxxxxxxxxxx" | Password | Required | This token represents your app and enables you to authenticate requests that require OAuth 2.0 Bearer Token authentication. |
Action: Tweet Search
This action performs a tweet search using a query. This helps to discover Twitter conversations about a particular topic or event.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the query string to perform a tweet search. Example: "sample event 2021" | Text | Required | |
Max Results | Enter the maximum number of tweets to retrieve (maximum of 100 per distinct request). | Integer | Optional | |
Pagination Token | Enter the token to paginate with. This parameter is used to move forward or backwards through pages of results, based on the pagination value. Example: 10 | Text | Optional | |
Start Time | Enter the start time to retrieve the tweets. Format is YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be retrieved. | Text | Optional | |
End Time | Enter the end time before which the tweets will be retrieved. Format is YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest, most recent UTC timestamp to which the Tweets will be retrieved. | Text | Optional | |
Since ID | Enter the Since ID to return the results with a Tweet ID greater than (that is, more recent than) the specified ID. | Text | Optional | |
Until ID | Enter the Until ID to return the results with a Tweet ID less than (that is, older than) the specified ID. | Text | Optional |
Example Request
[
{
"query": "sample event 2021",
"start_time": "2021-07-06T00:00:00Z",
"max_results": 100
}
]Action: User Timeline Lookup
This action retrieves the most recent tweets published by a specific Twitter user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the ID of the user to search for tweets. Example: "1344373682815209472" | Text | Required | You can retrieve the User ID using the Search User by Name action |
Max Results | Enter the maximum number of tweets to retrieve (maximum of 100 per distinct request). | Integer | Optional | |
Pagination Token | Enter the token to paginate with. This parameter is used to move forward or backwards through pages of results, based on the pagination value. Example: 10 | Text | Optional | |
Start Time | Enter the start time to retrieve the tweets. Format is YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be retrieved. | Text | Optional | |
End Time | Enter the end time before which the tweets will be retrieved. Format is YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest, most recent UTC timestamp to which the Tweets will be retrieved. | Text | Optional | |
Since ID | Enter the Since ID to return the results with a Tweet ID greater than (that is, more recent than) the specified ID. | Text | Optional | |
Until ID | Enter the Until ID to return the results with a Tweet ID less than (that is, older than) the specified ID. | Text | Optional |
Example Request
[
{
"user_id": "1344373682815209472",
"max_results": "10"
}
]Action: Multiple Tweet Lookup
This action retrieves details about multiple tweets using the requested IDs.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Tweet IDs | Enter the IDs of the tweets to search in a comma-separated format. Example: ["1228393702244134912","1227640996038684673","1199786642791452673"] | List | Required | You can retrieve the Tweet ID using the Tweet Search action. |
Example Request
[
{
"tweet_ids":
[
"1228393702244134912","1227640996038684673","1199786642791452673"
]
}
]Action: Tweet Lookup
This action retrieves details about a tweet.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Tweet ID | Enter the ID of the tweet to search. Example: "1228393702244134912" | Text | Required | You can retrieve the Tweet ID using the Tweet Search action. |
Example Request
[
{
"tweet_id": "1228393702244134912"
}
]Action: Search User By ID
This action retrieves details about a specific user using the user ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the ID of the user to retrieve details about. Example: "2244994945" | Text | Required | You can retrieve the User ID using the Search User by Name action. |
Example Request
[
{
"user_id": "2244994945"
}
]Action: Search User By Name
This action is used to retrieve details of a user via username.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the name of the user to retrieve details about. Example: "sampleuser" | Text | Required |
Example Request
[
{
"username": "sampleuser"
}
]