Push API Usage Overview

In general, using the Push API requires the following set up:

  1. Create a Push source (see Creating a Push Source).
  2. If your Push source is secured, create a security identity provider for it (see Creating a Security Identity Provider for a Secured Push Source).
  3. Create any fields you require in your index (see Creating Fields).

    In contrast with creating a standard source, creating a Push source never generates fields in your index as a side effect.

  4. Configure any mappings you require in your Push source (see Managing the Mapping Configuration of a Source).

    In contrast with a standard source, a new Push source does not include default mappings. However you should be aware that Push sources have a peculiar default behavior when it comes to populating fields with metadata values (see Understanding Push Source Item Metadata).

After this set up, you would use the Push API. In general this consists in writing code to regularly:

  1. Extract item data/metadata, and possibly permissions and security identities, from an original content repository.
  2. Add, update, and/or delete content as appropriate in your Push source and security identity provider using the Push API. See:

If you have never used the Push API before, a good way to get started is to go through the Push API Usage Example.