Create Solution Article with Freshservice API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Solution Article with the Freshservice 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 Typeform trigger and Freshservice action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Solution Article action
1. Connect your Freshservice account
2. Configure Title
3. Configure Description
4. Select a Solution Category ID
5. Select a Solution Folder ID
6. Select a Solution Article Status
7. Optional- Select a Solution Article Type
8. Optional- Configure Tags
9. Optional- Configure Keywords
10. Optional- Configure Review Date
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform 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.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Solution Article on Freshservice

Description:Create a solution article. [See the documentation](https://api.freshservice.com/#create_solution_article)

Version:0.0.1

Key:freshservice-create-solution-article

View on GitHub

Freshservice Overview#

The Freshservice API opens up a realm of possibilities for streamlining IT service management processes. It allows you to interact programmatically with Freshservice features, such as creating tickets, managing users, updating service catalog items, and more. Leveraging the Freshservice API on Pipedream, you can automate repetitive tasks, create complex workflows that react to events in Freshservice in real time, and connect Freshservice to a multitude of other services to enhance its capabilities and your productivity.

Action Code#

import freshservice from "../../freshservice.app.mjs";

export default {
  key: "freshservice-create-solution-article",
  name: "Create Solution Article",
  description: "Create a solution article. [See the documentation](https://api.freshservice.com/#create_solution_article)",
  version: "0.0.1",
  type: "action",
  props: {
    freshservice,
    title: {
      type: "string",
      label: "Title",
      description: "The title of the solution article",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the solution article",
    },
    categoryId: {
      propDefinition: [
        freshservice,
        "solutionCategoryId",
      ],
    },
    folderId: {
      propDefinition: [
        freshservice,
        "solutionFolderId",
        (c) => ({
          solutionCategoryId: c.categoryId,
        }),
      ],
    },
    status: {
      propDefinition: [
        freshservice,
        "solutionArticleStatus",
      ],
    },
    articleType: {
      propDefinition: [
        freshservice,
        "solutionArticleType",
      ],
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "The tags of the solution article",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "The keywords of the solution article",
      optional: true,
    },
    reviewDate: {
      type: "string",
      label: "Review Date",
      description: "Date in future when this article would need to be reviewed again. E.g. `2020-03-29T16:44:26Z`",
      optional: true,
    },
  },
  async run({ $ }) {
    const { article } = await this.freshservice.createSolutionArticle({
      $,
      data: {
        title: this.title,
        description: this.description,
        folder_id: this.folderId,
        article_type: this.articleType,
        status: this.status,
        tags: this.tags,
        keywords: this.keywords,
        review_date: this.reviewDate,
      },
    });
    $.export("$summary", `Successfully created solution article with ID ${article.id}`);
    return article;
  },
};

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
Freshservice	`freshservice`	`app`	This component uses the Freshservice app.
Title	`title`	`string`	The title of the solution article
Description	`description`	`string`	The description of the solution article
Solution Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Solution Folder ID	`folderId`	`string`	Select a value from the drop down menu.
Solution Article Status	`status`	`integer`	Select a value from the drop down menu:`{ "label": "Draft", "value": 1 }{ "label": "Published", "value": 2 }`
Solution Article Type	`articleType`	`integer`	Select a value from the drop down menu:`{ "label": "Permanent", "value": 1 }{ "label": "Workaround", "value": 2 }`
Tags	`tags`	`string[]`	The tags of the solution article
Keywords	`keywords`	`string[]`	The keywords of the solution article
Review Date	`reviewDate`	`string`	Date in future when this article would need to be reviewed again. E.g. `2020-03-29T16:44:26Z`

Action Authentication#

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

Your Freshservice API key is in your Profile > Settings page, below the change password section on the right.

Your domain is displayed in your Freshdesk URL. For example, https://{your_domain_here}.freshservice.com/.

Create Solution Article with Freshservice API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Freshservice, Typeform 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