Create Content Item with Kontent.ai API on New Survey Created from SurveyMethods API

Pipedream makes it easy to connect APIs for Kontent.ai, SurveyMethods and 3,000+ other apps remarkably fast.

Trigger workflow on

New Survey Created from the SurveyMethods API

Next, do this

Create Content Item with the Kontent.ai 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 SurveyMethods trigger and Kontent.ai action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Survey Created trigger
1. Connect your SurveyMethods account
2. Configure timer
Configure the Create Content Item action
1. Connect your Kontent.ai account
2. Configure Name
3. Optional- Configure Codename
4. Select a Type Id
5. Optional- Select a Collection Id
6. Optional- Configure External Id
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 Survey Created on SurveyMethods

Description:Emit new event on a survey is created.

Version:0.0.3

Key:surveymethods-new-survey-created

View on GitHub

SurveyMethods Overview#

The SurveyMethods API allows users to automate the management and analysis of surveys and the corresponding data. With the Pipedream integration, you can trigger workflows based on survey events, sync survey results with other databases or apps, and manage survey distribution programmatically. This serves to streamline the survey process from distribution to data actioning, all in real-time and without the need for manual intervention.

Trigger Code#

import surveymethods from "../../surveymethods.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  name: "New Survey Created",
  version: "0.0.3",
  key: "surveymethods-new-survey-created",
  description: "Emit new event on a survey is created.",
  type: "source",
  dedupe: "unique",
  props: {
    surveymethods,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const surveys = await this.surveymethods.getSurveys({
        perPage: 10,
      });

      surveys.reverse().forEach(this.emitEvent);
    },
  },
  methods: {
    async emitEvent(data) {
      this.$emit(data, {
        id: data.code,
        summary: `New survey created with code ${data.code}`,
        ts: Date.parse(data.created_date),
      });
    },
  },
  async run() {
    let page = 1;

    while (page >= 0) {
      const surveys = await this.surveymethods.getSurveys({
        page,
        perPage: 100,
      });

      surveys.reverse().forEach(this.emitEvent);

      if (surveys.length < 100) {
        return;
      }

      page++;
    }
  },
};

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
SurveyMethods	`surveymethods`	`app`	This component uses the SurveyMethods app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Use your account email address as your Login ID.
To get your API Key, follow the below steps:

Log in to your SurveyMethods account using your login id and password. The email
address that you provide during the registration will be your login id.
Go to the My Account Section.
Click on the API tab.

About SurveyMethods#

SurveyMethods provides powerful online survey software tool, advanced data analysis, email newsletters, and a comprehensive survey API.

Action#

Create Content Item on Kontent.ai

Description:Create a new content item based on a specific content type. [See the documentation](https://kontent.ai/learn/docs/apis/openapi/management-api-v2/#operation/add-a-content-item)

Version:0.0.2

Key:kontent_ai-create-content-item

View on GitHub

Kontent.ai Overview#

The Kontent.ai API offers robust content management capabilities for developers to manage and deliver content across various platforms. With this API, you can automate content creation, update content items, retrieve assets, and sync your content with other services. On Pipedream, you can harness these features to create powerful workflows that trigger on specific events, process data, and connect with other apps to streamline your content operations.

Action Code#

import kontentAi from "../../kontent_ai.app.mjs";

export default {
  key: "kontent_ai-create-content-item",
  name: "Create Content Item",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Create a new content item based on a specific content type. [See the documentation](https://kontent.ai/learn/docs/apis/openapi/management-api-v2/#operation/add-a-content-item)",
  type: "action",
  props: {
    kontentAi,
    name: {
      type: "string",
      label: "Name",
      description: "The content item's display name.",
    },
    codename: {
      type: "string",
      label: "Codename",
      description: "If not defined, it is [initially generated](https://kontent.ai/learn/docs/apis/openapi/management-api-v2/#section/Rules-for-codenames) from the item's **name** and can later be modified.",
      optional: true,
    },
    typeId: {
      propDefinition: [
        kontentAi,
        "typeId",
      ],
    },
    collectionId: {
      propDefinition: [
        kontentAi,
        "collectionId",
      ],
      optional: true,
    },
    externalId: {
      type: "string",
      label: "External Id",
      description: "The content item's external ID. The external ID can be used as a unique identifier to retrieve content from a different system.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      kontentAi,
      typeId,
      collectionId,
      externalId,
      ...data
    } = this;

    let collection = {};
    if (collectionId) {
      collection = {
        collection: {
          id: collectionId,
        },
      };
    }

    const { data: response } = await kontentAi.createContentItem({
      ...data,
      type: {
        id: typeId,
      },
      ...collection,
      externalId,
    });

    $.export("$summary", `A new content item with Id: ${response.id} was successfully created!`);
    return response;
  },
};

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
Kontent.ai	`kontentAi`	`app`	This component uses the Kontent.ai app.
Name	`name`	`string`	The content item's display name.
Codename	`codename`	`string`	If not defined, it is initially generated from the item's name and can later be modified.
Type Id	`typeId`	`string`	Select a value from the drop down menu.
Collection Id	`collectionId`	`string`	Select a value from the drop down menu.
External Id	`externalId`	`string`	The content item's external ID. The external ID can be used as a unique identifier to retrieve content from a different system.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Kontent.ai account and sign in
Click the User menu on the left bottom
Go to “Projects.”
On one of your projects click “Open Project.”
Click the Environment menu located on the second column at the top
Go to “API Keys.”
Create a new key under "Management API keys" or "Delivery API keys" tab, depending on the Kontent.ai API you'd like to connect via Pipedream

To retrieve your Environment ID,

Navigate to your Kontent.ai account and sign in
Click the User menu on the left bottom
Go to “Projects”
On one of your projects click “Open Project”
Click the Environment menu located on the second column at the top
On one of your environments, click the More Actions option with the three dots (“Open Project”)
Go to “Environment Settings.”

About Kontent.ai#

Complete control over your content. Kontent AI is the headless CMS that enables organizations to govern all things content to deliver standout experiences.