IntegrationsService

A list of all methods in the IntegrationsService service. Click on the method name to view detailed information about that method.

Methods	Description
saveInboxInstallation	Creates a new installation of a inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
startInboxInstallation	Initiates the installation flow for a inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
saveSlackInstallation	Creates a new installation of a slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
finishSlackInstallation	Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack.
startSlackInstallation	Initiates the installation flow for a slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
saveTemplatesInstallation	Creates a new installation of a templates integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
saveWebPushInstallation	Creates a new installation of a web_push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
startWebPushInstallation	Initiates the installation flow for a web_push integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.

saveInboxInstallation

Creates a new installation of a inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

• HTTP Method: POST
• Endpoint: /integrations/inbox/installations

Parameters

Name	Type	Required	Description
body	InboxConfig	❌	The request body.

Return Type

InboxConfig

Example Usage Code Snippet

import { Client, InboxConfig } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const images: Images = {
    emptyInboxUrl: 'emptyInboxUrl',
  };

  const banner: Banner = {
    backgroundColor: 'backgroundColor',
    backgroundOpacity: 9.57,
    fontSize: 'fontSize',
    textColor: 'textColor',
  };

  const dialog: Dialog = {
    accentColor: 'accentColor',
    backgroundColor: 'backgroundColor',
    textColor: 'textColor',
  };

  const footer: Footer = {
    backgroundColor: 'backgroundColor',
    borderRadius: 'borderRadius',
    fontSize: 'fontSize',
    textColor: 'textColor',
  };

  const header: Header = {
    backgroundColor: 'backgroundColor',
    borderRadius: 'borderRadius',
    fontFamily: 'fontFamily',
    fontSize: 'fontSize',
    textColor: 'textColor',
  };

  const icon: Icon = {
    borderColor: 'borderColor',
    width: 'width',
  };

  const defaultHover: DefaultHover = {
    backgroundColor: 'backgroundColor',
  };

  const defaultState: DefaultState = {
    color: 'color',
  };

  const default_: Default_ = {
    backgroundColor: 'backgroundColor',
    borderRadius: 'borderRadius',
    fontFamily: 'fontFamily',
    fontSize: 'fontSize',
    hover: defaultHover,
    margin: 'margin',
    state: defaultState,
    textColor: 'textColor',
  };

  const unreadHover: UnreadHover = {
    backgroundColor: 'backgroundColor',
  };

  const unreadState: UnreadState = {
    color: 'color',
  };

  const unread: Unread = {
    backgroundColor: 'backgroundColor',
    hover: unreadHover,
    state: unreadState,
    textColor: 'textColor',
  };

  const unseenHover: UnseenHover = {
    backgroundColor: 'backgroundColor',
  };

  const unseenState: UnseenState = {
    color: 'color',
  };

  const unseen: Unseen = {
    backgroundColor: 'backgroundColor',
    hover: unseenHover,
    state: unseenState,
    textColor: 'textColor',
  };

  const notification: Notification = {
    default: default_,
    unread: unread,
    unseen: unseen,
  };

  const unseenBadge: UnseenBadge = {
    backgroundColor: 'backgroundColor',
  };

  const theme: Theme = {
    banner: banner,
    dialog: dialog,
    footer: footer,
    header: header,
    icon: icon,
    notification: notification,
    unseenBadge: unseenBadge,
  };

  const inboxConfig: InboxConfig = {
    images: images,
    locale: 'locale',
    theme: theme,
  };

  const { data } = await client.integrations.saveInboxInstallation(inboxConfig);

  console.log(data);
})();

startInboxInstallation

Initiates the installation flow for a inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.

• HTTP Method: POST
• Endpoint: /integrations/inbox/installations/start

Return Type

InboxConfig

Example Usage Code Snippet

import { Client } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const { data } = await client.integrations.startInboxInstallation();

  console.log(data);
})();

saveSlackInstallation

Creates a new installation of a slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

• HTTP Method: POST
• Endpoint: /integrations/slack/installations

Parameters

Name	Type	Required	Description
body	SlackInstallation	❌	The request body.

Return Type

SlackInstallation

Example Usage Code Snippet

import { Client, SlackInstallation } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const authedUser: AuthedUser = {
    accessToken: 'access_token',
    expiresIn: 7,
    id: 'id',
    refreshToken: 'refresh_token',
    scope: 'scope',
    tokenType: 'token_type',
  };

  const enterprise: Enterprise = {
    id: 'id',
    name: 'name',
  };

  const incomingWebhook: IncomingWebhook = {
    channel: 'channel',
    configurationUrl: 'configuration_url',
    url: 'url',
  };

  const team: Team = {
    id: 'id',
    name: 'name',
  };

  const slackInstallation: SlackInstallation = {
    accessToken: 'access_token',
    appId: 'app_id',
    authedUser: authedUser,
    botUserId: 'bot_user_id',
    enterprise: enterprise,
    expiresIn: 10,
    id: 'YDW09447',
    incomingWebhook: incomingWebhook,
    isEnterpriseInstall: true,
    refreshToken: 'refresh_token',
    scope: 'scope',
    team: team,
    tokenType: 'token_type',
  };

  const { data } = await client.integrations.saveSlackInstallation(slackInstallation);

  console.log(data);
})();

finishSlackInstallation

Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack.

• HTTP Method: POST
• Endpoint: /integrations/slack/installations/finish

Parameters

Name	Type	Required	Description
body	SlackFinishInstallResponse	❌	The request body.

Return Type

SlackInstallation

Example Usage Code Snippet

import { Client, SlackFinishInstallResponse } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const slackFinishInstallResponse: SlackFinishInstallResponse = {
    appId: 'app_id',
    code: 'code',
    redirectUrl: 'redirect_url',
  };

  const { data } = await client.integrations.finishSlackInstallation(slackFinishInstallResponse);

  console.log(data);
})();

startSlackInstallation

Initiates the installation flow for a slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.

• HTTP Method: POST
• Endpoint: /integrations/slack/installations/start

Parameters

Name	Type	Required	Description
body	SlackStartInstall	❌	The request body.

Return Type

SlackStartInstallResponseContent

Example Usage Code Snippet

import { Client, SlackStartInstall } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const slackStartInstall: SlackStartInstall = {
    appId: 'app_id',
    authUrl: 'auth_url',
    extraScopes: ['extra_scopes'],
    redirectUrl: 'redirect_url',
  };

  const { data } = await client.integrations.startSlackInstallation(slackStartInstall);

  console.log(data);
})();

saveTemplatesInstallation

Creates a new installation of a templates integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

• HTTP Method: POST
• Endpoint: /integrations/templates/installations

Parameters

Name	Type	Required	Description
body	TemplatesInstallation	❌	The request body.

Return Type

TemplatesInstallation

Example Usage Code Snippet

import { Client, TemplatesInstallation } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const templatesInstallation: TemplatesInstallation = {
    category: 'category',
    channel: 'channel',
    text: 'text',
  };

  const { data } = await client.integrations.saveTemplatesInstallation(templatesInstallation);

  console.log(data);
})();

saveWebPushInstallation

Creates a new installation of a web_push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

• HTTP Method: POST
• Endpoint: /integrations/web_push/installations

Parameters

Name	Type	Required	Description
body	WebPushToken	❌	The request body.

Return Type

WebPushToken

Example Usage Code Snippet

import { Client, WebPushToken } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const keys: Keys = {
    auth: 'auth',
    p256dh: 'p256dh',
  };

  const webPushToken: WebPushToken = {
    endpoint: 'endpoint',
    keys: keys,
  };

  const { data } = await client.integrations.saveWebPushInstallation(webPushToken);

  console.log(data);
})();

startWebPushInstallation

Initiates the installation flow for a web_push integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.

• HTTP Method: POST
• Endpoint: /integrations/web_push/installations/start

Return Type

WebPushStartInstallationResponse

Example Usage Code Snippet

import { Client } from '@magicbell/user-client';

(async () => {
  const client = new Client({
    token: 'YOUR_TOKEN',
  });

  const { data } = await client.integrations.startWebPushInstallation();

  console.log(data);
})();