Create Project with Crowdin API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Crowdin, BigCommerce and 2,800+ other apps remarkably fast.

Trigger workflow on

New Custom Events from the BigCommerce API

Next, do this

Create Project with the Crowdin API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a BigCommerce trigger and Crowdin action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Custom Events trigger
1. Connect your BigCommerce account
2. Configure Using channel
Configure the Create Project action
1. Connect your Crowdin account
2. Configure Project Name
3. Select a Source Language ID
4. Optional- Select one or more Target Language IDs
5. Optional- Configure Identifier
6. Optional- Select a Visibility
7. Optional- Select a Language Access Policy
8. Optional- Configure Custom Domain Name
9. Optional- Configure Project Description
10. Optional- Select a Tags Detection
11. Optional- Configure Allow Machine Translation
12. Optional- Configure Task Based Access Control
13. Optional- Configure Auto Substitution
14. Optional- Configure Auto Translate Dialects
15. Optional- Configure Public Downloads
16. Optional- Configure Hidden Strings Proofreaders Access
17. Optional- Configure Use Global Translation Memory
18. Optional- Configure Show TM Suggestions for Dialects
19. Optional- Configure Skip Untranslated Strings
20. Optional- Configure Export Approved Only
21. Optional- Configure QA Check Is Active
22. Optional- Select a Type
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Custom Events on BigCommerce

Description:Emit new custom webhook event

Version:0.0.2

Key:bigcommerce-custom-events

View on GitHub

BigCommerce Overview#

The BigCommerce API enables merchants to seamlessly manage their e-commerce operations by automating tasks, syncing data, and integrating with a plethora of other services. With Pipedream, you can tap into the BigCommerce API to create custom workflows that handle everything from order processing to customer relationship management. The result is a more efficient, personalized shopping experience for customers and less manual work for store owners.

Trigger Code#

import bigcommerce from "../../bigcommerce.app.mjs";
import constants from "../../common/constants.mjs";
import { filterObj } from "../../utils.mjs";
import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Custom Events",
  version: "0.0.2",
  type: "source",
  key: "bigcommerce-custom-events",
  description: "Emit new custom webhook event",
  props: {
    ...common.props,
    channel: {
      propDefinition: [
        bigcommerce,
        "channel",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.channel) {
      props.channelId = {
        type: "string",
        label: "Channel Id",
        description: "Id of the channel",
      };
    }

    props.type = {
      type: "string",
      label: "Webhook type",
      description: "Type of the webhook",
      options: Object.getOwnPropertyNames(
        filterObj(
          constants.WEBHOOK_SCOPES,
          (scope) => !!scope[this.channel
            ? "channel"
            : "default"],
        ),
      ),
      reloadProps: true,
    };

    if (this.type) {
      const scope = constants.WEBHOOK_SCOPES[this.type];
      props.scope = {
        type: "string",
        label: "Scope of the webhook",
        options: this.channel
          ? scope.channel
          : scope.default,
      };
    }

    return props;
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const hookId = await this.bigcommerce.createHook(
        this.http.endpoint,
        this.type,
        this.scope,
        this.channel,
        this.channelId,
      );
      this.setHookId(hookId);
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "Custom event created";
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
BigCommerce	`bigcommerce`	`app`	This component uses the BigCommerce app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Using channel	`channel`	`boolean`	Channel of the webhook

Trigger Authentication#

BigCommerce uses API keys for authentication. When you connect your BigCommerce account, Pipedream securely stores the keys so you can easily authenticate to BigCommerce APIs in both code and no-code steps.

Navigate to Settings > API > Store-level API accounts
Name the account (it will only be visible to store users)
In the OAuth Scopes section, select the minimum scopes the app will require
Press Save.

The base API path will look something like this: https://api.bigcommerce.com/stores/123456/

In example above, the store_hash is 123456. Enter this and the access token below.

About BigCommerce#

Ecommerce for a New Era

Action#

Create Project on Crowdin

Description:Creates a new project within Crowdin. [See the documentation](https://support.crowdin.com/developer/api/v2/#/projects-api/create-project)

Version:0.0.1

Key:crowdin-create-project

View on GitHub

Crowdin Overview#

The Crowdin API offers a way to streamline localization processes by enabling automated interactions with Crowdin projects. With this API on Pipedream, you can create workflows that manage translations, coordinate with translators, and sync localized content across your apps. It becomes easy to upload new source files, download translations, manage projects, and crowdsource translations, all within the Pipedream ecosystem.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  LANGUAGE_ACCESS_POLICY_OPTIONS,
  TAGS_DETECTION_OPTIONS,
  VISIBILITY_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import crowdin from "../../crowdin.app.mjs";

export default {
  key: "crowdin-create-project",
  name: "Create Project",
  description: "Creates a new project within Crowdin. [See the documentation](https://support.crowdin.com/developer/api/v2/#/projects-api/create-project)",
  version: "0.0.1",
  type: "action",
  props: {
    crowdin,
    name: {
      type: "string",
      label: "Project Name",
      description: "The name of the project to be created",
    },
    sourceLanguageId: {
      propDefinition: [
        crowdin,
        "sourceLanguageId",
      ],
    },
    targetLanguageIds: {
      propDefinition: [
        crowdin,
        "sourceLanguageId",
      ],
      type: "string[]",
      label: "Target Language IDs",
      description: "Array of target language IDs",
      optional: true,
    },
    identifier: {
      type: "string",
      label: "Identifier",
      description: "A custom identifier for the project",
      optional: true,
    },
    visibility: {
      type: "string",
      label: "Visibility",
      description: "Defines how users can join the project.",
      options: VISIBILITY_OPTIONS,
      optional: true,
    },
    languageAccessPolicy: {
      type: "string",
      label: "Language Access Policy",
      description: "Defines access to project languages.",
      optional: true,
      options: LANGUAGE_ACCESS_POLICY_OPTIONS,
    },
    cname: {
      type: "string",
      label: "Custom Domain Name",
      description: "Custom domain name for the project.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Project Description",
      description: "The description of the project.",
      optional: true,
    },
    tagsDetection: {
      type: "string",
      label: "Tags Detection",
      description: "The type of the tags detection.",
      options: TAGS_DETECTION_OPTIONS,
      optional: true,
    },
    isMtAllowed: {
      type: "boolean",
      label: "Allow Machine Translation",
      description: "Allows machine translations to be visible for translators. Default is **true**.",
      optional: true,
    },
    taskBasedAccessControl: {
      type: "boolean",
      label: "Task Based Access Control",
      description: "Allow project members to work with tasks they're assigned to. Default is **false**.",
      optional: true,
      default: false,
    },
    autoSubstitution: {
      type: "boolean",
      label: "Auto Substitution",
      description: "Allows auto-substitution. Default is **true**.",
      optional: true,
      default: true,
    },
    autoTranslateDialects: {
      type: "boolean",
      label: "Auto Translate Dialects",
      description: "Automatically fill in regional dialects. Default is **false**.",
      optional: true,
    },
    publicDownloads: {
      type: "boolean",
      label: "Public Downloads",
      description: "Allows translators to download source files. Default is **true**.",
      optional: true,
    },
    hiddenStringsProofreadersAccess: {
      type: "boolean",
      label: "Hidden Strings Proofreaders Access",
      description: "Allows proofreaders to work with hidden strings. Default is **true**.",
      optional: true,
      default: true,
    },
    useGlobalTm: {
      type: "boolean",
      label: "Use Global Translation Memory",
      description: "If true, machine translations from connected MT engines will appear as suggestions. Default is **true**.",
      optional: true,
    },
    showTmSuggestionsDialects: {
      type: "boolean",
      label: "Show TM Suggestions for Dialects",
      description: "Show primary language TM suggestions for dialects if there are no dialect-specific ones. Default is **true**.",
      optional: true,
      default: true,
    },
    skipUntranslatedStrings: {
      type: "boolean",
      label: "Skip Untranslated Strings",
      description: "Defines whether to skip untranslated strings.",
      optional: true,
    },
    exportApprovedOnly: {
      type: "boolean",
      label: "Export Approved Only",
      description: "Defines whether to export only approved strings.",
      optional: true,
    },
    qaCheckIsActive: {
      type: "boolean",
      label: "QA Check Is Active",
      description: "If true, QA checks are active. Default is **true**.",
      optional: true,
    },
    type: {
      type: "string",
      label: "Type",
      description: "Defines the project type. To create a file-based project, use 0.",
      options: [
        "0",
        "1",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const {
        crowdin,
        type,
        targetLanguageIds,
        tagsDetection,
        ...data
      } = this;

      const response = await crowdin.createProject({
        $,
        data: {
          ...data,
          type: parseInt(type),
          targetLanguageIds: parseObject(targetLanguageIds),
          tagsDetection: parseInt(tagsDetection),
        },
      });
      $.export("$summary", `Project created successfully with Id: ${response.data.id}`);
      return response;
    } catch ({ response }) {
      throw new ConfigurationError(response.data.errors[0]?.error?.errors[0]?.message);
    }
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Crowdin	`crowdin`	`app`	This component uses the Crowdin app.
Project Name	`name`	`string`	The name of the project to be created
Source Language ID	`sourceLanguageId`	`string`	Select a value from the drop down menu.
Target Language IDs	`targetLanguageIds`	`string[]`	Select a value from the drop down menu.
Identifier	`identifier`	`string`	A custom identifier for the project
Visibility	`visibility`	`string`	Select a value from the drop down menu:`{ "label": "Open - anyone can join the project", "value": "open" }{ "label": "Private - only invited users can join the project", "value": "private" }`
Language Access Policy	`languageAccessPolicy`	`string`	Select a value from the drop down menu:`{ "label": "Open - each project user can access all project languages", "value": "open" }{ "label": "Moderate - users should join each project language separately", "value": "moderate" }`
Custom Domain Name	`cname`	`string`	Custom domain name for the project.
Project Description	`description`	`string`	The description of the project.
Tags Detection	`tagsDetection`	`string`	Select a value from the drop down menu:`{ "label": "Auto", "value": "0" }{ "label": "Count Tags", "value": "1" }{ "label": "Skip Tags", "value": "2" }`
Allow Machine Translation	`isMtAllowed`	`boolean`	Allows machine translations to be visible for translators. Default is true.
Task Based Access Control	`taskBasedAccessControl`	`boolean`	Allow project members to work with tasks they're assigned to. Default is false.
Auto Substitution	`autoSubstitution`	`boolean`	Allows auto-substitution. Default is true.
Auto Translate Dialects	`autoTranslateDialects`	`boolean`	Automatically fill in regional dialects. Default is false.
Public Downloads	`publicDownloads`	`boolean`	Allows translators to download source files. Default is true.
Hidden Strings Proofreaders Access	`hiddenStringsProofreadersAccess`	`boolean`	Allows proofreaders to work with hidden strings. Default is true.
Use Global Translation Memory	`useGlobalTm`	`boolean`	If true, machine translations from connected MT engines will appear as suggestions. Default is true.
Show TM Suggestions for Dialects	`showTmSuggestionsDialects`	`boolean`	Show primary language TM suggestions for dialects if there are no dialect-specific ones. Default is true.
Skip Untranslated Strings	`skipUntranslatedStrings`	`boolean`	Defines whether to skip untranslated strings.
Export Approved Only	`exportApprovedOnly`	`boolean`	Defines whether to export only approved strings.
QA Check Is Active	`qaCheckIsActive`	`boolean`	If true, QA checks are active. Default is true.
Type	`type`	`string`	Select a value from the drop down menu:`01`

Action Authentication#

Crowdin uses OAuth authentication. When you connect your Crowdin account, Pipedream will open a popup window where you can sign into Crowdin and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Crowdin API.

Pipedream requests the following authorization scopes when you connect your account:

notificationprojectmtwebhookai

Create Project with Crowdin API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Crowdin, BigCommerce and 2,800+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular