Create Render Job with Plainly API on New Phone Collected (Instant) from WisePops API

Pipedream makes it easy to connect APIs for Plainly, WisePops and 2,500+ other apps remarkably fast.

Trigger workflow on

New Phone Collected (Instant) from the WisePops API

Next, do this

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

Select this integration
Configure the New Phone Collected (Instant) trigger
1. Connect your WisePops account
2. Optional- Select a Wisepop Id
Configure the Create Render Job action
1. Connect your Plainly account
2. Select a Project ID
3. Select a Template ID
4. Optional- Configure Attributes
5. Optional- Configure Parameters
6. Optional- Configure Configure Options
7. Optional- Select a Captions Position
8. Optional- Select a Captions Style
9. Optional- Configure SRT File URL
10. Optional- Configure Passthrough
11. Optional- Configure Skip All
12. Optional- Configure Thumbnail At Seconds
13. Optional- Select a Thumbnail Format
14. Optional- Configure Thumbnail Frequency Seconds
15. Optional- Configure Thumbnail From Encoded Video
16. Optional- Configure Watermark Encodeing Params Line
17. Optional- Configure Watermark URL
18. Optional- Configure Upload Enabled
19. Optional- Configure Configure Output Format
20. Optional- Configure Attachment
21. Optional- Configure Attachment File Name
22. Optional- Select a Output Module
23. Optional- Select a Settings Template
24. Optional- Configure Configure Webhook
25. Optional- Configure On Failure
26. Optional- Configure On Invalid
27. Optional- Configure Webhook URL
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 Phone Collected (Instant) on WisePops

Description:Emit new event when a new phone is received

Version:0.0.1

Key:wisepops-new-phone-collected

View on GitHub

WisePops Overview#

The WisePops API unlocks potent possibilities for automating pop-up and banners management on your website. By integrating WisePops with Pipedream, you can streamline workflows such as syncing lead data to CRM platforms, personalizing visitor engagement based on real-time analytics, and dynamically updating marketing campaigns. The API's ability to fetch, update, create, and delete pop-ups enables developers to orchestrate sophisticated marketing automation that reacts to customer behavior and data-driven insights.

Trigger Code#

import base from "../common/base.mjs";

export default {
  ...base,
  key: "wisepops-new-phone-collected",
  name: "New Phone Collected (Instant)",
  description: "Emit new event when a new phone is received",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  hooks: {
    ...base.hooks,
    async activate() {
      await this.activateHook("phone");
    },
  },
  methods: {
    ...base.methods,
    getSummary({
      fields, wisepop_id,
    }) {
      return `New phone: ${fields?.phone ?? wisepop_id}`;
    },
  },
};

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
WisePops	`wisepops`	`app`	This component uses the WisePops app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Wisepop Id	`wisepopId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To get your API Key, log into your WisePops account, click the Profile menu on the top right, then Settings, then Email API

About WisePops#

WisePops is a web application that helps you design smart pop-ups for your website, and increase sign ups and conversions

Action#

Create Render Job on Plainly

Description:Creates a render job for a video template. [See the documentation](https://www.plainlyvideos.com/documentation/api-reference)

Version:0.0.1

Key:plainly-create-render-job

View on GitHub

Action Code#

import plainly from "../../plainly.app.mjs";
import { parseObjectEntries } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "plainly-create-render-job",
  name: "Create Render Job",
  description: "Creates a render job for a video template. [See the documentation](https://www.plainlyvideos.com/documentation/api-reference)",
  version: "0.0.1",
  type: "action",
  props: {
    plainly,
    projectId: {
      propDefinition: [
        plainly,
        "projectId",
      ],
    },
    templateId: {
      propDefinition: [
        plainly,
        "templateId",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    attributes: {
      type: "object",
      label: "Attributes",
      description: "User-defined attributes of the render. The field batchRenderId is reserved and should be a string. The field batchRenderSequenceNo is reserved and should be a number. Keys in this map must not contain dots.",
      optional: true,
    },
    parameters: {
      type: "object",
      label: "Parameters",
      description: "Map of parameters to use in order to resolve the template parametrized layers. Keys in this map must not contain dots.",
      optional: true,
    },
    configureOptions: {
      type: "boolean",
      label: "Configure Options",
      description: "Set to `true` to enter values for the map of additional options for the render",
      optional: true,
      reloadProps: true,
    },
    captionsPosition: {
      type: "string",
      label: "Captions Position",
      description: "The position of captions. Default: `BOTTOM`",
      options: [
        "TOP",
        "CENTER",
        "BOTTOM",
      ],
      optional: true,
      hidden: true,
    },
    captionsStyle: {
      type: "string",
      label: "Captions Style",
      description: "The style of captions. Default: `BASIC`",
      options: [
        "BASIC",
        "BASIC_WITH_STROKE_AND_SHADOW",
        "BASIC_WITH_SHADOW",
        "POPPINS_WHITE",
        "POPPINS_WHITE_VERTICAL",
      ],
      optional: true,
      hidden: true,
    },
    srtFileUrl: {
      type: "string",
      label: "SRT File URL",
      description: "Url to the srt file",
      optional: true,
      hidden: true,
    },
    passthrough: {
      type: "string",
      label: "Passthrough",
      description: "Data to be sent to the integration as the integrationPassthrough parameter. Serves to pass arbitrary data to your active integrations. Could be any string or a render parameter reference in formats {{parameterName}} or {{parameterName:defaultValue}}, including a reference to {{webhookPassthrough}} in the same manner`.",
      optional: true,
      hidden: true,
    },
    skipAll: {
      type: "boolean",
      label: "Skip All",
      description: "If true, any active integration for this project or template will not be triggered.",
      optional: true,
      hidden: true,
    },
    thumbnailAtSeconds: {
      type: "string[]",
      label: "Thumbnail At Seconds",
      description: "Generated thumbnails would be PNG thumbnails based on specified timestamps in seconds",
      optional: true,
      hidden: true,
    },
    thumbnailFormat: {
      type: "string",
      label: "Thumbnail Format",
      description: "The format of the thumbnails",
      options: [
        "PNG",
        "JPG",
      ],
      optional: true,
      hidden: true,
    },
    thumbnailFrequencySeconds: {
      type: "integer",
      label: "Thumbnail Frequency Seconds",
      description: "Frequency in seconds to export a frame. For example, having the value frequencySeconds=5 and a rendered video that lasts 15 sec, would create 3 PNGs.",
      optional: true,
      hidden: true,
    },
    thumbnailFromEncodedVideo: {
      type: "boolean",
      label: "Thumbnail From Encoded Video",
      description: "When set to true, the thumbnails will be generated from the encoded video. If set to false, the thumbnails will be generated from the video outputted by the After Effects rendering process.",
      optional: true,
      hidden: true,
    },
    watermarkEncodingParamsLine: {
      type: "string",
      label: "Watermark Encodeing Params Line",
      description: "Additional ffmpeg command line parameters to change watermark position, size, etc. If not specified, the watermark is placed at the top left corner with opacity of 0.8.",
      optional: true,
      hidden: true,
    },
    watermarkUrl: {
      type: "string",
      label: "Watermark URL",
      description: "A public url to the watermark image or video",
      optional: true,
      hidden: true,
    },
    uploadEnabled: {
      type: "boolean",
      label: "Upload Enabled",
      description: "Enables uploading modified project files as a zip archive",
      optional: true,
      hidden: true,
    },
    configureOutputFormat: {
      type: "boolean",
      label: "Configure Output Format",
      description: "Set to `true` to enter values used for rendering output. If not specified defaults to default output format for the target After Effects version",
      optional: true,
      reloadProps: true,
    },
    attachment: {
      type: "boolean",
      label: "Attachment",
      description: "If the output file should be consider as an attachment, meaning that the video link will initiate a download of the file in a web browser.",
      optional: true,
      hidden: true,
    },
    attachmentFileName: {
      type: "string",
      label: "Attachment File Name",
      description: "Optional, name of the file when downloading as attachment. Note that this has effect only if attachment is true. The file name must be provided without extension which will be added automatically based on the selected format.",
      optional: true,
      hidden: true,
    },
    outputModule: {
      type: "string",
      label: "Output Module",
      description: "The output module defines the format of the video generated by the After Effects",
      options: [
        "H_264",
        "H_264_HIGH_BIT_RATE",
        "HQ",
        "HQ_ALPHA",
      ],
      optional: true,
      hidden: true,
    },
    settingsTemplate: {
      type: "string",
      label: "Settings Template",
      description: "Defines render settings template to be used during After Effects rendering",
      options: [
        "BEST_SETTINGS",
        "DRAFT",
      ],
      optional: true,
      hidden: true,
    },
    configureWebhook: {
      type: "boolean",
      label: "Configure Webhook",
      description: "Set to `true` to enter webhook properties. A webhook HTTP(S) call expects a 2xx status code in order to be marked as successful. In case of a failed delivery, Plainly will attempt to re-call your webhook for up to one day in space of 15 minutes. A webhook HTTP(S) request has a timeout of 30 seconds. A webhook HTTP(S) request does follow redirects.",
      optional: true,
      reloadProps: true,
    },
    onFailure: {
      type: "boolean",
      label: "On Failure",
      description: "Should webhook be called also on the failed renders",
      optional: true,
      hidden: true,
    },
    onInvalid: {
      type: "boolean",
      label: "On Invalid",
      description: "Should webhook be called also on the invalid renders",
      optional: true,
      hidden: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "The HTTP(S) webhook URL to execute the POST call once the rendering is finished",
      optional: true,
      hidden: true,
    },
  },
  additionalProps(props) {
    // captions options
    props.captionsPosition.hidden = !this.configureOptions;
    props.captionsStyle.hidden = !this.configureOptions;
    props.srtFileUrl.hidden = !this.configureOptions;

    // integrations options
    props.passthrough.hidden = !this.configureOptions;
    props.skipAll.hidden = !this.configureOptions;

    // project files options
    props.uploadEnabled.hidden = !this.configureOptions;

    // thumbnail options
    props.thumbnailAtSeconds.hidden = !this.configureOptions;
    props.thumbnailFormat.hidden = !this.configureOptions;
    props.thumbnailFrequencySeconds.hidden = !this.configureOptions;
    props.thumbnailFromEncodedVideo.hidden = !this.configureOptions;

    // watermark options
    props.watermarkEncodingParamsLine.hidden = !this.configureOptions;
    props.watermarkUrl.hidden = !this.configureOptions;

    // output format config
    props.attachment.hidden = !this.configureOutputFormat;
    props.attachmentFileName.hidden = !this.configureOutputFormat;
    props.outputModule.hidden = !this.configureOutputFormat;
    props.settingsTemplate.hidden = !this.configureOutputFormat;

    // webhook config
    props.onFailure.hidden = !this.configureWebhook;
    props.onInvalid.hidden = !this.configureWebhook;
    props.webhookUrl.hidden = !this.configureWebhook;
    props.webhookUrl.optional = !this.configureWebhook;

    return {};
  },
  async run({ $ }) {
    if ((this.captionsPosition || this.captionsStyle) && !this.srtFileUrl) {
      throw new ConfigurationError("SRT File URL is required if setting Captions Position or Style");
    }

    if (this.watermarkEncodingParamsLine && !this.watermarkUrl) {
      throw new ConfigurationError("Must specify Watermark URL if specifying Watermark Encoding Params Line");
    }

    const response = await this.plainly.createRender({
      $,
      data: {
        projectId: this.projectId,
        templateId: this.templateId,
        attributes: parseObjectEntries(this.attributes),
        parameters: parseObjectEntries(this.parameters),
        options: {
          captions: this.srtFileUrl
            ? {
              captionsPosition: this.captionsPosition,
              captionsStyle: this.captionsStyle,
              srtFileUrl: this.srtFileUrl,
            }
            : undefined,
          integration: {
            passthrough: this.passthrough,
            skipAll: this.skipAll,
          },
          projectFiles: {
            uploadEnabled: this.uploadEnabled,
          },
          thumbnails: {
            atSeconds: this.thumbnailAtSeconds,
            format: this.thumbnailFormat,
            frequencySeconds: this.thumbnailFrequencySeconds,
            fromEncodedVideo: this.thumbnailFromEncodedVideo,
          },
          watermark: this.watermarkUrl
            ? {
              encodingParamsLine: this.watermarkEncodingParamsLine,
              url: this.watermarkUrl,
            }
            : undefined,
        },
        outputFormat: {
          attachment: this.attachment,
          attachmentFileName: this.attachmentFileName,
          outputModule: this.outputModule,
          settingsTemplate: this.settingsTemplate,
        },
        webhook: this.webhookUrl
          ? {
            onFailure: this.onFailure,
            onInvalid: this.onInvalid,
            url: this.webhookUrl,
          }
          : undefined,
      },
    });
    $.export("$summary", `Successfully created render with ID: ${response.id}`);
    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
Plainly	`plainly`	`app`	This component uses the Plainly app.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Attributes	`attributes`	`object`	User-defined attributes of the render. The field batchRenderId is reserved and should be a string. The field batchRenderSequenceNo is reserved and should be a number. Keys in this map must not contain dots.
Parameters	`parameters`	`object`	Map of parameters to use in order to resolve the template parametrized layers. Keys in this map must not contain dots.
Configure Options	`configureOptions`	`boolean`	Set to `true` to enter values for the map of additional options for the render
Configure Output Format	`configureOutputFormat`	`boolean`	Set to `true` to enter values used for rendering output. If not specified defaults to default output format for the target After Effects version
Configure Webhook	`configureWebhook`	`boolean`	Set to `true` to enter webhook properties. A webhook HTTP(S) call expects a 2xx status code in order to be marked as successful. In case of a failed delivery, Plainly will attempt to re-call your webhook for up to one day in space of 15 minutes. A webhook HTTP(S) request has a timeout of 30 seconds. A webhook HTTP(S) request does follow redirects.