Add or Edit a Coveo Twitter Source

Members of the Administrators and Content Managers built-in groups can add specific Twitter content to a Coveo organization. This content may consist in tweets:

  • Posted by a certain user

  • Containing certain keywords (hashtags)

  • Included in a certain list

  • Included in a certain collection

You want to index content regarding or related to your company. Therefore, you index tweets posted by your company account and by your CEO, as well as relevant keywords such as product, partner, and event names. You could also index existing lists or collections made by your company account or any other user.

In a Coveo-powered search interface, the source content is accessible to either everyone or the source creator only (see Content Security).

Source Key Characteristics

Features Supported Additional information
Twitter version Latest cloud version Following available Twitter releases
Searchable content types Users, tweets1, 2, lists, and collections
Content update operations Refresh Takes place every hour by default. See limitations.
Content security options Determined by source permissions
Source creator

1: Tweets posted by protected users (protected tweets) can’t be indexed.

2: Tweet keywords preceded by hashtags (#) or cashtags ($), and usernames (preceded by a @ character) are indexed as tweet metadata.


  • During a source refresh, deleted items can’t be detected and therefore require a source rescan or rebuild to be updated or removed.

  • Source refresh can’t be performed if the last refresh, rescan or rebuild didn’t end normally, i.e., the source was stopped, paused, or an exception occurred.

  • Only the first 140 characters of tweets are indexed.

  • Media content, such as pictures and videos, isn’t supported at this time.

Add or Edit a Twitter Source

When adding or editing a Twitter source, follow the instructions below.

“Configuration” Tab

In the Add/Edit a Twitter Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.

General Information

Source Name

Enter a name for your source.

A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

Item Type and Value to Index

Use the Item type drop-down menu to select the type of item to index. Click the plus sign (+) to add items. Available options are:

  • User

    Under Value to index, you can enter several usernames separated by a comma and a space character. You don’t need to use the preceding @ character.

    BBCNews, BBCBreaking, BBCWorld

  • List

    Under Value to index, enter the username of the list creator and the list name as it appears in the list URL. The username and the list name must be formatted as follows: username/list-name.

    For list, enter bbc/bbc-news.

  • Query

    Under Value to index, enter a string preceded by a hashtag (#) or a cashtag ($) character.

    • #breakingnews

    • $GOOG

  • Collection

    Under Value to index, enter the collection ID. You can find this numerical string in the collection page URL.

    For collection, enter collection ID 576828964162965504.

Character optical recognition (OCR)

If you want Coveo Cloud to extract text from image files or PDF files containing images, check the appropriate box. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.


When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

  • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Manage Privileges and Logical Indexes Domain).

  • Once the source is added, you can’t switch to a different index.

“Content to Include” Section

Select Old items to keep in the index the items that aren’t reindexed following a source configuration change. Unselect the option when you want to delete these items.

If indexing a user, select Mentions, Replies, Retweets, and Users’ followings (tweets of users followed by the users specified under Value to index) to index the corresponding content.

“Content Security” Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

“Access” Tab

In the Access tab, determine whether each group and API key can view or edit the source configuration (see Resource Access):

  1. In the Access Level column, select View or Edit for each available group.

  2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.


  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      To add the source content or to make your changes effective, on the Sources page, you must click Launch build or Start required rebuild in the source Status column.


    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources page, you can review the progress of your source addition or modification.

    Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings.

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

What’s Next?

Adapt the source update schedule to your needs.

Recommended Articles