Pricing Templates
Log in Sign up
Integrations / Algolia Ingestion / ...

POST /1/push/{indexName}

Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the watch parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the pre-indexing data transformation, this is the recommended way of ingesting your records. This method is similar to pushTask, but requires an indexName instead of a taskID. If zero or many tasks are found, an error will be returned.

Servers

Path parameters

Name Type Required Description
indexName String Yes

Name of the index on which to perform the operation.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
referenceIndexName String No

This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
watch Boolean No

When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.

Request body fields

Name Type Required Description
records[] Array Yes
records[].objectID String Yes

Unique record identifier.
action String Yes

Which indexing operation to perform:

  • addObject: adds records to an index. Equivalent to the "Add a new record (with auto-generated object ID)" operation.
  • updateObject: adds or replaces records in an index. Equivalent to the "Add or replace a record" operation.
  • partialUpdateObject: adds or updates attributes within records. Equivalent to the "Add or update attributes" operation with the createIfNoExists parameter set to true. (If a record with the specified objectID doesn't exist in the specified index, this action creates adds the record to the index)
  • partialUpdateObjectNoCreate: same as partialUpdateObject, but with createIfNoExists set to false. (A record isn't added to the index if its objectID doesn't exist)
  • deleteObject: delete records from an index. Equivalent to the "Delete a record" operation.
  • delete. Delete an index. Equivalent to the "Delete an index" operation.
  • clear: delete all records from an index. Equivalent to the "Delete all records from an index operation".

Valid values:

  • "clear"
  • "addObject"
  • "partialUpdateObjectNoCreate"
  • "deleteObject"
  • "updateObject"
  • "partialUpdateObject"
  • "delete"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy