Add or Edit a Push Source

In this article

The Coveo Push API lets you index content and make it make searchable, when a specific connector isn’t available.

Example

You have valuable content in an on-premises content management system (CMS) developed in-house. One of your developers can create a crawler to get this content and push it to your Coveo organization.

Before you can push content to Coveo, you must create a Push type source to which the content will be sent.

Tip
Leading practice

The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About Crawling Speed for information on what can impact crawling speed, as well as possible solutions.

Add or Edit a Push Source

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

"Configuration" Tab

On the Add/Edit a Push Source page, 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.

Tip
Leading practice

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.

When coding a crawler to push content in this source, a developer will need this name to get the corresponding sourceId.

Push API URL

Available only when you edit the source, the input contains the URL you must use to add and update an item in your source (see Manage Items and Permissions in a Push Source) in the following format:

Primay region URL

US

https://api.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

Europe

https://api-eu.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

Australia

https://api-au.cloud.coveo.com/push/v1/organizations/<ORGANIZATION_ID>/sources/<SOURCE_ID>/documents

The URL that you can Copy to clipboard contains your <ORGANIZATION_ID> and <SOURCE_ID>, which are required parameters for all operations regarding your source. See the Stream section in Push API to test API calls.

Optical Character Recognition (OCR)

If you want Coveo 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.

Note

Contact Coveo Sales to add this feature to your organization license.

API Key

When you create the source, we recommend also creating an API key with appropriate privileges to authorize a process and send information to the source. This option is available at source creation only.

Note

This option isn’t visible if you don’t have the Edit API keys privilege.

"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.

Note

If you select Same users and groups as in your content system, your crawler process must push item permissions along with the content (see Manage Security Identities in a Security Identity Provider and Manage Items and Permissions in a Push Source).

"Access" Tab

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

  1. If available, in the left pane, click Groups or API Keys to select the appropriate list.

  2. In the Access Level column for groups or API keys with access to source content, select View or Edit.

Completion

Important

The Your API Key dialog appears only once and is the only place where you can see and copy the key value.

If you fail to copy (or lose) the key value, the workaround is to manually create a new API key by selecting only the View and Edit check boxes for the Sources privileges of the Content service. In this case, you should also disable or delete the original unused API key.