Create Project with Crowdin API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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

About Crowdin#

Agile localization for tech companies. Crowdin is a cloud-based solution that streamlines localization management for your team. It's the perfect place to effectively manage all of your multilingual content.

More Ways to Connect Crowdin + Pipedream#

Other Popular Integrations#

Add File to Project with Crowdin API on New Scheduled Tasks from Pipedream API

Pipedream + Crowdin

Create Project with Crowdin API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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