Evolution Node SDK

Made by HEROwCode

Non official SDK for Evolution API.

Installation

Install Evolution Node SDK with npm

npm add @herowcode/evolution-node-sdk

yarn add @herowcode/evolution-node-sdk

pnpm add @herowcode/evolution-node-sdk

bun add @herowcode/evolution-node-sdk

Usage/Examples

import EvoSDK from '@herowcode/evolution-node-sdk'

const sdk = new EvoSDK({
  url: 'https://your-evolution-endpoint.com',
  globalApiKey: 'YOUR_API_KEY',
})

await sdk.init({ version: '1.7.4' })

await sdk.instance.fetch({
  instanceName: 'evolution-node-sdk'
})

Features

• Instance management
• Instance settings
• Profile management
• Instance integrations:
  • Proxy
  • Webhook

API Reference

Instances

/// Create
await sdk.instance.create(...);

/// Delete
await sdk.instance.delete(...);

/// Get single
await sdk.instance.fetch(...);

/// Get list
await sdk.instance.fetchList(...);

/// Logout
await sdk.instance.logout(...);

/// Restart
await sdk.instance.restart(...);

/// Status
await sdk.instance.delete(...);

Settings

/// Get instance settings
await sdk.instance.settings.fetch(...);

/// Define instance settings
await sdk.instance.settings.define(...);

Proxy integration

/// Get proxy info
await sdk.instance.integrations.proxy.fetch(...);

/// Define instance proxy
await sdk.instance.integrations.proxy.define(...);

/// Remove proxy
await sdk.instance.integrations.proxy.remove(...);

Webhook integration

/// Get webhook info
await sdk.instance.integrations.webhook.fetch(...);

/// Define instance webhook
await sdk.instance.integrations.webhook.define(...);

/// Remove webhook
await sdk.instance.integrations.webhook.remove(...);

Profile

/// Get whatsapp profile
await sdk.profile.fetch(...);

/// Get whatsapp business profile
await sdk.profile.fetchBusiness(...);

/// Get privacy settings
await sdk.profile.privacySettings(...);

/// Update privacy settings
await sdk.profile.updatePrivacySettings(...);

/// Update name
await sdk.profile.updateName(...);

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Related

Here are some related projects

• Evolution API
• Evolution Docs
• Evolution Manager

License

The MIT License (MIT). Please see License File for more information.