chatwoot-chatwoot

Namespace

chatwoot-chatwoot

Description:

  • Transform your customer service with Chatwoot, the open-source platform that centralizes conversations across channels. Empower your team with AI-driven support, omnichannel integration, and insightful analytics.

Author:
Copyright:
  • 2026 Eyevinn Technology AB

Methods

(async, static) createChatwootChatwootInstance(context, body) → {ChatwootChatwoot}

Description:

  • Create a new Chatwoot instance

Example
import { Context } from '@osaas/client-core';
import { createChatwootChatwootInstance } from '@osaas/client-services';

const ctx = new Context();
const body: ChatwootChatwootConfig = { name: 'myinstance', ... };
const instance = await createChatwootChatwootInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body ChatwootChatwootConfig

Service instance configuration
Returns:
  • Service instance
Type
ChatwootChatwoot

(async, static) getChatwootChatwootInstance(context, name) → {ChatwootChatwoot}

Description:

  • Get a Chatwoot instance

Example
import { Context } from '@osaas/client-core';
import { getChatwootChatwootInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getChatwootChatwootInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the chatwoot to be retrieved
Returns:
  • Service instance
Type
ChatwootChatwoot

(async, static) removeChatwootChatwootInstance(context, name)

Description:

  • Remove a Chatwoot instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the chatwoot to be removed