IntegrationsService

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

Methods	Description
listIntegrations	Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.
getApnsIntegration	Retrieves the current apns integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveApnsIntegration	Creates or updates a apns integration for the project. Only administrators can configure integrations.
deleteApnsIntegration	Removes a apns integration configuration from the project. This will disable the integration's functionality within the project.
deleteApnsIntegrationById	Removes a specific apns integration instance by ID from the project.
getAwssnsIntegration	Retrieves the current awssns integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveAwssnsIntegration	Creates or updates a awssns integration for the project. Only administrators can configure integrations.
deleteAwssnsIntegration	Removes a awssns integration configuration from the project. This will disable the integration's functionality within the project.
deleteAwssnsIntegrationById	Removes a specific awssns integration instance by ID from the project.
getExpoIntegration	Retrieves the current expo integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveExpoIntegration	Creates or updates a expo integration for the project. Only administrators can configure integrations.
deleteExpoIntegration	Removes a expo integration configuration from the project. This will disable the integration's functionality within the project.
deleteExpoIntegrationById	Removes a specific expo integration instance by ID from the project.
getFcmIntegration	Retrieves the current fcm integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveFcmIntegration	Creates or updates a fcm integration for the project. Only administrators can configure integrations.
deleteFcmIntegration	Removes a fcm integration configuration from the project. This will disable the integration's functionality within the project.
deleteFcmIntegrationById	Removes a specific fcm integration instance by ID from the project.
getGithubIntegration	Retrieves the current github integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveGithubIntegration	Creates or updates a github integration for the project. Only administrators can configure integrations.
deleteGithubIntegration	Removes a github integration configuration from the project. This will disable the integration's functionality within the project.
deleteGithubIntegrationById	Removes a specific github integration instance by ID from the project.
getInboxIntegration	Retrieves the current inbox integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveInboxIntegration	Creates or updates a inbox integration for the project. Only administrators can configure integrations.
deleteInboxIntegration	Removes a inbox integration configuration from the project. This will disable the integration's functionality within the project.
deleteInboxIntegrationById	Removes a specific inbox integration instance by ID from the project.
getMailgunIntegration	Retrieves the current mailgun integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveMailgunIntegration	Creates or updates a mailgun integration for the project. Only administrators can configure integrations.
deleteMailgunIntegration	Removes a mailgun integration configuration from the project. This will disable the integration's functionality within the project.
deleteMailgunIntegrationById	Removes a specific mailgun integration instance by ID from the project.
getPingEmailIntegration	Retrieves the current ping_email integration configurations for a specific integration type in the project. Returns configuration details and status information.
savePingEmailIntegration	Creates or updates a ping_email integration for the project. Only administrators can configure integrations.
deletePingEmailIntegration	Removes a ping_email integration configuration from the project. This will disable the integration's functionality within the project.
deletePingEmailIntegrationById	Removes a specific ping_email integration instance by ID from the project.
getSendgridIntegration	Retrieves the current sendgrid integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveSendgridIntegration	Creates or updates a sendgrid integration for the project. Only administrators can configure integrations.
deleteSendgridIntegration	Removes a sendgrid integration configuration from the project. This will disable the integration's functionality within the project.
deleteSendgridIntegrationById	Removes a specific sendgrid integration instance by ID from the project.
getSesIntegration	Retrieves the current ses integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveSesIntegration	Creates or updates a ses integration for the project. Only administrators can configure integrations.
deleteSesIntegration	Removes a ses integration configuration from the project. This will disable the integration's functionality within the project.
deleteSesIntegrationById	Removes a specific ses integration instance by ID from the project.
getSlackIntegration	Retrieves the current slack integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveSlackIntegration	Creates or updates a slack integration for the project. Only administrators can configure integrations.
deleteSlackIntegration	Removes a slack integration configuration from the project. This will disable the integration's functionality within the project.
deleteSlackIntegrationById	Removes a specific slack integration instance by ID from the project.
getStripeIntegration	Retrieves the current stripe integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveStripeIntegration	Creates or updates a stripe integration for the project. Only administrators can configure integrations.
deleteStripeIntegration	Removes a stripe integration configuration from the project. This will disable the integration's functionality within the project.
deleteStripeIntegrationById	Removes a specific stripe integration instance by ID from the project.
getTemplatesIntegration	Retrieves the current templates integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveTemplatesIntegration	Creates or updates a templates integration for the project. Only administrators can configure integrations.
deleteTemplatesIntegration	Removes a templates integration configuration from the project. This will disable the integration's functionality within the project.
deleteTemplatesIntegrationById	Removes a specific templates integration instance by ID from the project.
getTwilioIntegration	Retrieves the current twilio integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveTwilioIntegration	Creates or updates a twilio integration for the project. Only administrators can configure integrations.
deleteTwilioIntegration	Removes a twilio integration configuration from the project. This will disable the integration's functionality within the project.
deleteTwilioIntegrationById	Removes a specific twilio integration instance by ID from the project.
getWebPushIntegration	Retrieves the current web_push integration configurations for a specific integration type in the project. Returns configuration details and status information.
saveWebPushIntegration	Creates or updates a web_push integration for the project. Only administrators can configure integrations.
deleteWebPushIntegration	Removes a web_push integration configuration from the project. This will disable the integration's functionality within the project.
deleteWebPushIntegrationById	Removes a specific web_push integration instance by ID from the project.

listIntegrations

Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.

• HTTP Method: GET
• Endpoint: /integrations

Parameters

Name	Type	Required	Description
pageSize	number	❌
pageAfter	string	❌
pageBefore	string	❌

Return Type

ArrayOfIntegrationObjects

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.listIntegrations({
    pageSize: 3,
    pageAfter: 'page[after]',
    pageBefore: 'page[before]',
  });

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

getApnsIntegration

Retrieves the current apns integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/apns

Return Type

ArrayOfApnsConfigObjects

Example Usage Code Snippet

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

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

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

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

saveApnsIntegration

Creates or updates a apns integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/apns

Parameters

Name	Type	Required	Description
body	ApnsConfig	❌	The request body.

Return Type

ApnsConfig

Example Usage Code Snippet

import { ApnsConfig, Client } from '@magicbell/project-client';

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

  const badge = Badge.UNREAD;

const payloadVersion = PayloadVersion._1;

const apnsConfig: ApnsConfig = {
  appId: "app_id",
  badge: badge,
  certificate: "----- BEGIN PRIVATE KEY----------
42qmz9=
---- END PRIVATE KEY-
",
  keyId: "mollit dol",
  payloadVersion: payloadVersion,
  teamId: "enimmollit"
};

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

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

deleteApnsIntegration

Removes a apns integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/apns

Example Usage Code Snippet

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

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

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

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

deleteApnsIntegrationById

Removes a specific apns integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/apns/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteApnsIntegrationById('id');

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

getAwssnsIntegration

Retrieves the current awssns integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/awssns

Return Type

ArrayOfAwssnsConfigObjects

Example Usage Code Snippet

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

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

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

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

saveAwssnsIntegration

Creates or updates a awssns integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/awssns

Parameters

Name	Type	Required	Description
body	AwssnsConfig	❌	The request body.

Return Type

AwssnsConfig

Example Usage Code Snippet

import { AwssnsConfig, Client } from '@magicbell/project-client';

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

  const awssnsConfig: AwssnsConfig = {
    webhookSigningSecret: 'webhook_signing_secret',
  };

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

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

deleteAwssnsIntegration

Removes a awssns integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/awssns

Example Usage Code Snippet

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

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

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

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

deleteAwssnsIntegrationById

Removes a specific awssns integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/awssns/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteAwssnsIntegrationById('id');

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

getExpoIntegration

Retrieves the current expo integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/expo

Return Type

ArrayOfExpoConfigObjects

Example Usage Code Snippet

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

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

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

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

saveExpoIntegration

Creates or updates a expo integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/expo

Parameters

Name	Type	Required	Description
body	ExpoConfig	❌	The request body.

Return Type

ExpoConfig

Example Usage Code Snippet

import { Client, ExpoConfig } from '@magicbell/project-client';

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

  const expoConfig: ExpoConfig = {
    accessToken: 'access_token',
  };

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

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

deleteExpoIntegration

Removes a expo integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/expo

Example Usage Code Snippet

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

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

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

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

deleteExpoIntegrationById

Removes a specific expo integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/expo/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteExpoIntegrationById('id');

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

getFcmIntegration

Retrieves the current fcm integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/fcm

Return Type

ArrayOfFcmConfigObjects

Example Usage Code Snippet

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

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

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

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

saveFcmIntegration

Creates or updates a fcm integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/fcm

Parameters

Name	Type	Required	Description
body	FcmConfig	❌	The request body.

Return Type

FcmConfig

Example Usage Code Snippet

import { Client, FcmConfig } from '@magicbell/project-client';

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

  const type_ = Type_.SERVICE_ACCOUNT;

const fcmConfig: FcmConfig = {
  authProviderX509CertUrl: "auth_provider_x509_cert_url",
  authUri: "auth_uri",
  clientEmail: "client_email",
  clientId: "client_id",
  clientX509CertUrl: "client_x509_cert_url",
  privateKey: "BEGINNQX--------
B+JvPM/f7Ms==
------ENDEPJVIYYY-----
",
  privateKeyId: "private_key_id",
  projectId: "project_id",
  tokenUri: "token_uri",
  type: type_,
  universeDomain: "universe_domain"
};

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

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

deleteFcmIntegration

Removes a fcm integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/fcm

Example Usage Code Snippet

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

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

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

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

deleteFcmIntegrationById

Removes a specific fcm integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/fcm/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteFcmIntegrationById('id');

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

getGithubIntegration

Retrieves the current github integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/github

Return Type

ArrayOfGithubConfigObjects

Example Usage Code Snippet

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

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

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

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

saveGithubIntegration

Creates or updates a github integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/github

Parameters

Name	Type	Required	Description
body	GithubConfig	❌	The request body.

Return Type

GithubConfig

Example Usage Code Snippet

import { Client, GithubConfig } from '@magicbell/project-client';

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

  const githubConfig: GithubConfig = {
    webhookSigningSecret: 'webhook_signing_secret',
  };

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

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

deleteGithubIntegration

Removes a github integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/github

Example Usage Code Snippet

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

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

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

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

deleteGithubIntegrationById

Removes a specific github integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/github/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteGithubIntegrationById('id');

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

getInboxIntegration

Retrieves the current inbox integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/inbox

Return Type

ArrayOfInboxConfigObjects

Example Usage Code Snippet

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

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

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

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

saveInboxIntegration

Creates or updates a inbox integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/inbox

Parameters

Name	Type	Required	Description
body	InboxConfig	❌	The request body.

Return Type

InboxConfig

Example Usage Code Snippet

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

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

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

  const banner: Banner = {
    backgroundColor: 'backgroundColor',
    backgroundOpacity: 4.92,
    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.saveInboxIntegration(inboxConfig);

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

deleteInboxIntegration

Removes a inbox integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/inbox

Example Usage Code Snippet

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

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

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

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

deleteInboxIntegrationById

Removes a specific inbox integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/inbox/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteInboxIntegrationById('id');

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

getMailgunIntegration

Retrieves the current mailgun integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/mailgun

Return Type

ArrayOfMailgunConfigObjects

Example Usage Code Snippet

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

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

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

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

saveMailgunIntegration

Creates or updates a mailgun integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/mailgun

Parameters

Name	Type	Required	Description
body	MailgunConfig	❌	The request body.

Return Type

MailgunConfig

Example Usage Code Snippet

import { Client, MailgunConfig } from '@magicbell/project-client';

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

  const mailgunConfigRegion = MailgunConfigRegion.US;

  const mailgunConfig: MailgunConfig = {
    apiKey: 'api_key',
    domain: 'domain',
    region: mailgunConfigRegion,
  };

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

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

deleteMailgunIntegration

Removes a mailgun integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/mailgun

Example Usage Code Snippet

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

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

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

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

deleteMailgunIntegrationById

Removes a specific mailgun integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/mailgun/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteMailgunIntegrationById('id');

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

getPingEmailIntegration

Retrieves the current ping_email integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/ping_email

Return Type

ArrayOfPingConfigObjects

Example Usage Code Snippet

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

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

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

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

savePingEmailIntegration

Creates or updates a ping_email integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/ping_email

Parameters

Name	Type	Required	Description
body	PingConfig	❌	The request body.

Return Type

PingConfig

Example Usage Code Snippet

import { Client, PingConfig } from '@magicbell/project-client';

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

  const pingConfig: PingConfig = {
    url: 'url',
  };

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

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

deletePingEmailIntegration

Removes a ping_email integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/ping_email

Example Usage Code Snippet

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

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

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

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

deletePingEmailIntegrationById

Removes a specific ping_email integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/ping_email/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deletePingEmailIntegrationById('id');

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

getSendgridIntegration

Retrieves the current sendgrid integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/sendgrid

Return Type

ArrayOfSendgridConfigObjects

Example Usage Code Snippet

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

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

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

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

saveSendgridIntegration

Creates or updates a sendgrid integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/sendgrid

Parameters

Name	Type	Required	Description
body	SendgridConfig	❌	The request body.

Return Type

SendgridConfig

Example Usage Code Snippet

import { Client, SendgridConfig } from '@magicbell/project-client';

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

  const sendgridConfigFrom: SendgridConfigFrom = {
    email: 'email',
    name: 'name',
  };

  const replyTo: ReplyTo = {
    email: 'email',
    name: 'name',
  };

  const sendgridConfig: SendgridConfig = {
    apiKey: 'api_key',
    from: sendgridConfigFrom,
    replyTo: replyTo,
  };

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

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

deleteSendgridIntegration

Removes a sendgrid integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/sendgrid

Example Usage Code Snippet

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

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

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

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

deleteSendgridIntegrationById

Removes a specific sendgrid integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/sendgrid/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteSendgridIntegrationById('id');

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

getSesIntegration

Retrieves the current ses integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/ses

Return Type

ArrayOfSesConfigObjects

Example Usage Code Snippet

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

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

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

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

saveSesIntegration

Creates or updates a ses integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/ses

Parameters

Name	Type	Required	Description
body	SesConfig	❌	The request body.

Return Type

SesConfig

Example Usage Code Snippet

import { Client, SesConfig } from '@magicbell/project-client';

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

  const sesConfigFrom: SesConfigFrom = {
    email: 'email',
    name: 'name',
  };

  const sesConfig: SesConfig = {
    endpoint: 'endpoint',
    from: sesConfigFrom,
    keyId: 'key_id',
    region: 'region',
    secretKey: 'secret_key',
  };

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

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

deleteSesIntegration

Removes a ses integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/ses

Example Usage Code Snippet

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

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

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

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

deleteSesIntegrationById

Removes a specific ses integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/ses/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteSesIntegrationById('id');

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

getSlackIntegration

Retrieves the current slack integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/slack

Return Type

ArrayOfSlackConfigObjects

Example Usage Code Snippet

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

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

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

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

saveSlackIntegration

Creates or updates a slack integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/slack

Parameters

Name	Type	Required	Description
body	SlackConfig	❌	The request body.

Return Type

SlackConfig

Example Usage Code Snippet

import { Client, SlackConfig } from '@magicbell/project-client';

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

  const slackConfig: SlackConfig = {
    appId: 'QTEIRE',
    clientId: '7201.6182620',
    clientSecret: 'ex dolore ametauteDuis culpaquis',
    signingSecret: 'eu ex animmollit sunt consequat ',
  };

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

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

deleteSlackIntegration

Removes a slack integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/slack

Example Usage Code Snippet

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

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

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

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

deleteSlackIntegrationById

Removes a specific slack integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/slack/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteSlackIntegrationById('id');

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

getStripeIntegration

Retrieves the current stripe integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/stripe

Return Type

ArrayOfStripeConfigObjects

Example Usage Code Snippet

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

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

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

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

saveStripeIntegration

Creates or updates a stripe integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/stripe

Parameters

Name	Type	Required	Description
body	StripeConfig	❌	The request body.

Return Type

StripeConfig

Example Usage Code Snippet

import { Client, StripeConfig } from '@magicbell/project-client';

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

  const stripeConfig: StripeConfig = {
    webhookSigningSecret: 'webhook_signing_secret',
  };

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

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

deleteStripeIntegration

Removes a stripe integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/stripe

Example Usage Code Snippet

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

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

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

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

deleteStripeIntegrationById

Removes a specific stripe integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/stripe/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteStripeIntegrationById('id');

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

getTemplatesIntegration

Retrieves the current templates integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/templates

Return Type

ArrayOfTemplatesConfigObjects

Example Usage Code Snippet

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

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

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

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

saveTemplatesIntegration

Creates or updates a templates integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/templates

Parameters

Name	Type	Required	Description
body	any	❌	The request body.

Return Type

any

Example Usage Code Snippet

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

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

  const input = {};

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

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

deleteTemplatesIntegration

Removes a templates integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/templates

Example Usage Code Snippet

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

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

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

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

deleteTemplatesIntegrationById

Removes a specific templates integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/templates/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteTemplatesIntegrationById('id');

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

getTwilioIntegration

Retrieves the current twilio integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/twilio

Return Type

ArrayOfTwilioConfigObjects

Example Usage Code Snippet

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

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

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

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

saveTwilioIntegration

Creates or updates a twilio integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/twilio

Parameters

Name	Type	Required	Description
body	TwilioConfig	❌	The request body.

Return Type

TwilioConfig

Example Usage Code Snippet

import { Client, TwilioConfig } from '@magicbell/project-client';

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

  const twilioConfigRegion = TwilioConfigRegion.US1;

  const twilioConfig: TwilioConfig = {
    accountSid: 'account_sid',
    apiKey: 'api_key',
    apiSecret: 'api_secret',
    from: '+0528138710599',
    region: twilioConfigRegion,
  };

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

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

deleteTwilioIntegration

Removes a twilio integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/twilio

Example Usage Code Snippet

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

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

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

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

deleteTwilioIntegrationById

Removes a specific twilio integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/twilio/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteTwilioIntegrationById('id');

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

getWebPushIntegration

Retrieves the current web_push integration configurations for a specific integration type in the project. Returns configuration details and status information.

• HTTP Method: GET
• Endpoint: /integrations/web_push

Return Type

ArrayOfWebpushConfigObjects

Example Usage Code Snippet

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

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

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

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

saveWebPushIntegration

Creates or updates a web_push integration for the project. Only administrators can configure integrations.

• HTTP Method: PUT
• Endpoint: /integrations/web_push

Parameters

Name	Type	Required	Description
body	WebpushConfig	❌	The request body.

Return Type

WebpushConfig

Example Usage Code Snippet

import { Client, WebpushConfig } from '@magicbell/project-client';

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

  const webpushConfig: WebpushConfig = {
    privateKey: 'private_key',
    publicKey: 'public_key',
  };

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

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

deleteWebPushIntegration

Removes a web_push integration configuration from the project. This will disable the integration's functionality within the project.

• HTTP Method: DELETE
• Endpoint: /integrations/web_push

Example Usage Code Snippet

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

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

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

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

deleteWebPushIntegrationById

Removes a specific web_push integration instance by ID from the project.

• HTTP Method: DELETE
• Endpoint: /integrations/web_push/{id}

Parameters

Name	Type	Required	Description
id	string	✅

Example Usage Code Snippet

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

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

  const { data } = await client.integrations.deleteWebPushIntegrationById('id');

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