Configure API push

The API push source is a source configuration to create and maintain indexes exclusively for content you push to Sitecore Search. After you configure an API push source, a developer uses the Ingestion API to add documents to the API push source's index.

For example, assume that your content is on a social networking-type site that consists exclusively of visitor-generated content. Visitors create, update, and delete content every few seconds. To ensure that the latest content is always searchable, you can create an API push source and, in your application, have a developer set up a webhook that calls the Ingestion API every time content is created, updated, or deleted.

Important

To successfully index your searchable content, refer to our recommended best indexing practices.

This walkthrough describes how to:

Create an API push source

You have to create a source before you can configure it.

To create a source:

On the menu bar, click Sources.
Click Add Source.
In the SOURCE NAME field, enter a name for the source.

For example, enter Blog push source.
In the DESCRIPTION field, enter a few lines to describe the source you want to configure.

For example, enter Push source for rush content for English and French
In the CONNECTOR field, click the type of source you want to create.

Here, click API Push.
Click Save. If there are no errors, Search creates a new source.

Publish the source

You must publish the API push source before you can use the Ingestion API to create index documents and add them to this index.

To publish the source:

On the Source Settings page, click Publish.
To confirm, click Publish.

Now, a developer can use the Ingestion API to create, update, and later, even delete, index documents for this source.

Do you have some feedback for us?

If you have suggestions for improving this article,