# zvolv-sdk

> Zvolv developer kit for Javascript

Latest version **0.6.0** (published 2025-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install zvolv-sdk
pnpm add zvolv-sdk
yarn add zvolv-sdk
bun add zvolv-sdk
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2025-11-13 |
| First published | 2024-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 110.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Akshay Jadhav |
| Maintainers | akshay-zestl |
| Keywords | SDK, Zvolv, api, No-Code/Low-Code, Hyper-automation |

## Links

- npm: https://www.npmjs.com/package/zvolv-sdk
- Repository: https://github.com/zvolvapi/js-zvolv-sdk
- Homepage: https://github.com/zvolvapi/js-zvolv-sdk#readme
- Issues: https://github.com/zvolvapi/js-zvolv-sdk/issues
- npm.io page: https://npm.io/package/zvolv-sdk

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.6.7
- [js-sha512](https://npm.io/package/js-sha512.md) ^0.9.0

## Recent versions

- 0.6.0 (latest) — 2025-11-13
- 0.5.0 — 2025-07-28
- 0.4.0 — 2025-07-14
- 0.3.0 — 2025-07-08
- 0.2.0 — 2025-03-07
- 0.1.0 — 2025-03-02
- 0.0.13 — 2024-05-21
- 0.0.12 — 2024-03-07
- 0.0.11 — 2024-03-07
- 0.0.10 — 2024-03-07
- 0.0.9 — 2024-02-27
- 0.0.7 — 2024-02-19
- 0.0.6 — 2024-02-19
- 0.0.5 — 2024-02-18
- 0.0.4 — 2024-02-18
- … 2 more at https://npm.io/package/zvolv-sdk/versions

## README

<!-- # js-zvolv-sdk
Javascript Software Development Kit for Zvolv APIs


To test using node and typescript.
Install tsx globally
npm install --global tsx   

Run sample script using tsx
tsx --no-cache ./sample.ts  -->

# ZvolvClient SDK

ZvolvClient SDK is a JavaScript Software Development Kit for interacting with the Zvolv API.


To test using node and typescript. Install tsx globally npm install --global tsx Run sample script using tsx tsx --no-cache ./sample.ts 


## Installation

To install ZvolvClient SDK, use npm:

```bash
npm i zvolv-sdk

```
# Usage
## Initialize ZvolvClient

constructor(baseURL: string)

Initializes the ZvolvClient with the base URL of the Zvolv server.

Once the package is installed, you can import the library using import or require approach:

```javascript
import { ZvolvClient } from "zvolv-client-sdk";

const client = new ZvolvClient('http://twig-me.com');

```

## Initialize Workspace

methods for interacting with workspaces.

```javascript

try {
    const workspace = await client.workspace.init('kapilwf');
} catch (error) {
    console.error('Error initializing workspace:', error);
}

```
## Perform Authentication

methods for authentication.

```javascript
try {
    const login = await client.auth.login('email', 'pass');
} catch (error) {
    console.error('Error performing login:', error);
}
```
## Perform Analytics Search
methods for performing analytics-related operations.

```javascript
try {
    const analytics = await client.analytics.search('65c470f6dab3102c930725ca', { query: { match_all: {} }, from: 0, size: 20, track_total_hits: true });
} catch (error) {
    console.error('Error performing analytics search:', error);
}

```
## Fetch Form

methods for fetching form details.

```javascript
try {
    const formId = '65c470f6dab3102c930725ca'; // Replace with the appropriate form ID
    const form = await client.form.fetch(formId);
} catch (error) {
    console.error('Error fetching form:', error);
}
```
## Create Submission

methods for creating submissions.

Define query parameters for the submission creation request.

If not provided, default values of false will be used for skipAutomation and skipValidations.

```javascript
try {
    const submissionData = {
        formId: '65c470f6dab3102c930725ca', // Replace with the appropriate formId
        elements: [
            {
                label: 'Name',
                value: 'Test'
            }
        ]
    };

    const queryParams = {
        skipAutomation: true,
        skipValidations: false,
    };

    const createdSubmission = await client.submission.create(submissionData, queryParams);
} catch (error) {
    console.error('Error creating submission:', error);
}
```

# License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/zvolvapi/js-zvolv-sdk/blob/main/LICENSE) file for details.

---
_Source: https://npm.io/package/zvolv-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._