Overview
Algolia
This CDK catalogue package is pinned to @activepieces/piece-algolia@0.1.0 and declares 4 declared actions and no declared triggers. Its definition is derived from the exact reviewed Activepieces source.
Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.
Technical guide
Technical reference
- Package:
@activepieces/piece-algolia@0.1.0 - Exact artifact digest:
sha256:e7d4f442b8400a8225febf6a7576aff215ba0ecac683e2cdfcf72e5e95fd2ce4 - Source: the exact reviewed Activepieces source
- Authentication, action and trigger schemas are taken from the exact pinned package.
Capability summary
Authentication
Authentication method: custom
Authentication profiles
connection · custom
- Application ID Required
- API Key Required · protected credential
Supported objects
| Object | Read | Write | Notes |
|---|---|---|---|
| Save Records | Yes | No | |
| Browse Records | Yes | No | |
| Delete Records | Yes | No | |
| Custom API Call | Yes | No |
Supported actions
Save Records · Read
Adds or updates records in an Algolia index.
save_records · Risk: low · Retry: safe
Inputs
indexName· string · Required, Enter an existing index name or a new one u2014 Algolia creates it automatically.records· object · Required, Provide an array of JSON objects to save. Include `objectID` to update an existing record, or omit it to let Algolia create one.
Browse Records · Read
Retrieves records from an Algolia index.
browse_records · Risk: low · Retry: safe
Inputs
indexName· string · Required, Select the Algolia index to use.limit· number · Optional, Maximum number of records to retrieve. Defaults to 10,000.
Delete Records · Read
Deletes records from an Algolia index by objectID.
delete_records · Risk: low · Retry: safe
Inputs
indexName· string · Required, Select the Algolia index to use.recordIds· array · Required, Provide the Algolia objectIDs to delete from the selected index.
Custom API Call · Read
Make a custom API call to a specific endpoint
custom_api_call · Risk: low · Retry: safe
Inputs
url· object · Requiredmethod· string · Requiredheaders· object · Optional, Authorization headers are injected automatically from your connection.queryParams· object · Optional, Appended to the URL as ?key=value.body_type· string · Optionalbody· object · Optionalresponse_is_binary· boolean · Optional, Enable for files like PDFs, images, etc.failsafe· boolean · Optional, On a failed request, output the error instead of failing the step.timeout· number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).followRedirects· boolean · Optional, Follow 3xx redirects instead of returning them as the response.
Setup
Setup
Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.
Limitations
The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.