POST /1/destinations

Creates a new destination.

Servers

Request headers

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

Default value: "application/json"

Request body fields

Name Type Required Description
authenticationID String No

Universally unique identifier (UUID) of an authentication resource.

name String Yes

Descriptive name for the resource.

input Object Yes
input.indexName String Yes

Algolia index name (case-sensitive).

input.attributesToExclude[] Array No

Attributes from your source to exclude from Algolia records.

Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance.

  • Exclude nested attributes with . notation. For example, foo.bar indexes the foo attribute and all its children except the bar attribute.
  • Exclude attributes from arrays with [i], where i is the index of the array element. For example, foo.[0].bar only excludes the bar attribute from the first element of the foo array, but indexes the complete foo attribute for all other elements. Use * as wildcard: foo.[*].bar excludes bar from all elements of the foo array.
input.recordType String No

Record type for ecommerce sources.

Possible values:

  • "variant"
  • "product"
  • "collection"
transformationIDs[] Array No
type String Yes

Destination type.

  • search. Data is stored in an Algolia index.

  • insights. Data is recorded as user events in the Insights API.

Possible values:

  • "search"
  • "insights"

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.