Find Lead with WhatConverts API on Student Added to Course from Xperiencify API

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

Trigger workflow on

Student Added to Course from the Xperiencify API

Next, do this

Find Lead with the WhatConverts 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 Xperiencify trigger and WhatConverts action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Student Added to Course trigger
1. Connect your Xperiencify account
2. Configure timer
3. Select a Course
Configure the Find Lead action
1. Connect your WhatConverts account
2. Optional- Select a Account ID
3. Optional- Select a Profile ID
4. Optional- Select a Lead Type
5. Optional- Select a Lead Status
6. Optional- Configure Start Date
7. Optional- Configure End Date
8. Optional- Select a Order
9. Optional- Select a Quotable
10. Optional- Select a Quote Value
11. Optional- Select a Sales Value
12. Optional- Configure Phone Number
13. Optional- Configure Email Address
14. Optional- Configure Spam
15. Optional- Configure Duplicate
16. Optional- Configure Lead Source
17. Optional- Configure Lead Medium
18. Optional- Configure Lead Campaign
19. Optional- Configure Lead Content
20. Optional- Configure Lead Keyword
21. Optional- Configure Max Results
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#

Student Added to Course on Xperiencify

Description:Emit new event when a student enrolls into a course.

Version:0.0.2

Key:xperiencify-student-added-to-course

View on GitHub

Xperiencify Overview#

Xperiencify is a platform designed to create engaging online courses that motivate students through gamification and psychological triggers. The Xperiencify API allows course creators to manage and automate tasks related to courses, students, and their progress. With Pipedream, you can harness this API to create dynamic workflows that respond to course enrollments, progress milestones, and other student interactions. Automate notifications, gather analytics, synchronize with other platforms, and more, creating a seamless integration between Xperiencify and your digital ecosystem.

Trigger Code#

import { defineSource } from "@pipedream/types";
import xperiencify from "../../app/xperiencify.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
export default defineSource({
    name: "Student Added to Course",
    description: "Emit new event when a student enrolls into a course.",
    key: "xperiencify-student-added-to-course",
    version: "0.0.2",
    type: "source",
    dedupe: "unique",
    props: {
        xperiencify,
        db: "$.service.db",
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        courseId: {
            propDefinition: [
                xperiencify,
                "courseId",
            ],
        },
    },
    methods: {
        getMeta({ email, firstName, }) {
            return {
                id: email,
                summary: `New student ${firstName}: ${email}`,
                ts: new Date().getTime(),
            };
        },
    },
    async run() {
        const all = await this.xperiencify.getStudentsForCourse({
            courseId: this.courseId,
        });
        for (const student of all) {
            this.$emit(student, this.getMeta(student));
        }
    },
});

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
Xperiencify	`xperiencify`	`app`	This component uses the Xperiencify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Course	`courseId`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key:

Navigate to your Xperiencify account and sign in
Go to Account > Advanced > API

About Xperiencify#

Xperiencify is the world's first fully gamified online course platform that creates a hyper-engaging "experience" for your students.

Action#

Find Lead on WhatConverts

Description:Find a lead in WhatConverts. [See the documentation](https://www.whatconverts.com/api/leads/#get-all-leads)

Version:0.0.1

Key:whatconverts-find-lead

View on GitHub

WhatConverts Overview#

The WhatConverts API allows you to track, manage, and report on leads and conversions from various marketing channels. With this API, you can automate the ingestion of lead data into your CRM, generate custom reports, and receive real-time alerts for new leads. When you implement this API within Pipedream, you can create powerful, serverless workflows that respond to events in WhatConverts, or trigger actions based on data from other apps.

Action Code#

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

export default {
  key: "whatconverts-find-lead",
  name: "Find Lead",
  description: "Find a lead in WhatConverts. [See the documentation](https://www.whatconverts.com/api/leads/#get-all-leads)",
  version: "0.0.1",
  type: "action",
  props: {
    whatconverts,
    accountId: {
      propDefinition: [
        whatconverts,
        "accountId",
      ],
    },
    profileId: {
      propDefinition: [
        whatconverts,
        "profileId",
        (c) => ({
          accountId: c.accountId,
        }),
      ],
    },
    leadType: {
      propDefinition: [
        whatconverts,
        "leadType",
      ],
    },
    leadStatus: {
      type: "string",
      label: "Lead Status",
      description: "Lead status to return for this request",
      options: [
        "repeat",
        "unique",
      ],
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Start date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.",
      optional: true,
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "End date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.",
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "Order in which to return the leads by date created",
      options: [
        "asc",
        "desc",
      ],
      optional: true,
    },
    quotable: {
      type: "string",
      label: "Quotable",
      description: "Quotable type to return for this request",
      options: [
        "yes",
        "no",
        "pending",
        "not_set",
      ],
      optional: true,
    },
    quoteValue: {
      type: "string",
      label: "Quote Value",
      description: "Return leads that have a quote value",
      options: [
        "has_value",
        "no_value",
      ],
      optional: true,
    },
    salesValue: {
      type: "string",
      label: "Sales Value",
      description: "Return leads that have a sales value",
      options: [
        "has_value",
        "no_value",
      ],
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Return leads for the contacts that have this E.164 formatted phone number",
      optional: true,
    },
    emailAddress: {
      type: "string",
      label: "Email Address",
      description: "Return leads for the contact that have this email address",
      optional: true,
    },
    spam: {
      type: "boolean",
      label: "Spam",
      description: "If `true` will return only spam leads",
      optional: true,
    },
    duplicate: {
      type: "boolean",
      label: "Duplicate",
      description: "If true will return only duplicate leads",
      optional: true,
    },
    leadSource: {
      type: "string",
      label: "Lead Source",
      description: "Return leads that have this lead source",
      optional: true,
    },
    leadMedium: {
      type: "string",
      label: "Lead Medium",
      description: "Return leads that have this lead medium",
      optional: true,
    },
    leadCampaign: {
      type: "string",
      label: "Lead Campaign",
      description: "Return leads that have this lead campaign",
      optional: true,
    },
    leadContent: {
      type: "string",
      label: "Lead Content",
      description: "Return leads that have this lead content",
      optional: true,
    },
    leadKeyword: {
      type: "string",
      label: "Lead Keyword",
      description: "Return leads that have this lead keyword",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of results to return. Default: 100, Maximum: 2500",
      optional: true,
      default: 100,
    },
  },
  async run({ $ }) {
    const { leads } = await this.whatconverts.listLeads({
      $,
      params: {
        profile_id: this.profileId,
        lead_type: this.leadType,
        lead_status: this.leadStatus,
        start_date: this.startDate,
        end_date: this.endDate,
        order: this.order,
        quotable: this.quotable,
        quote_value: this.quoteValue,
        sales_value: this.salesValue,
        phone_number: this.phoneNumber,
        email_address: this.emailAddress,
        spam: this.spam,
        duplicate: this.duplicate,
        lead_source: this.leadSource,
        lead_medium: this.leadMedium,
        lead_campaign: this.leadCampaign,
        lead_content: this.leadContent,
        lead_keyword: this.leadKeyword,
        leads_per_page: this.maxResults,
      },
    });

    $.export("$summary", `Found ${leads.length} lead${leads.length === 1
      ? ""
      : "s"}`);
    return leads;
  },
};

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
WhatConverts	`whatconverts`	`app`	This component uses the WhatConverts app.
Account ID	`accountId`	`integer`	Select a value from the drop down menu.
Profile ID	`profileId`	`integer`	Select a value from the drop down menu.
Lead Type	`leadType`	`string`	Select a value from the drop down menu:`appointmentchatemaileventotherphone_calltext_messagetransactionweb_form`
Lead Status	`leadStatus`	`string`	Select a value from the drop down menu:`repeatunique`
Start Date	`startDate`	`string`	Start date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.
End Date	`endDate`	`string`	End date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Quotable	`quotable`	`string`	Select a value from the drop down menu:`yesnopendingnot_set`
Quote Value	`quoteValue`	`string`	Select a value from the drop down menu:`has_valueno_value`
Sales Value	`salesValue`	`string`	Select a value from the drop down menu:`has_valueno_value`
Phone Number	`phoneNumber`	`string`	Return leads for the contacts that have this E.164 formatted phone number
Email Address	`emailAddress`	`string`	Return leads for the contact that have this email address
Spam	`spam`	`boolean`	If `true` will return only spam leads
Duplicate	`duplicate`	`boolean`	If true will return only duplicate leads
Lead Source	`leadSource`	`string`	Return leads that have this lead source
Lead Medium	`leadMedium`	`string`	Return leads that have this lead medium
Lead Campaign	`leadCampaign`	`string`	Return leads that have this lead campaign
Lead Content	`leadContent`	`string`	Return leads that have this lead content
Lead Keyword	`leadKeyword`	`string`	Return leads that have this lead keyword
Max Results	`maxResults`	`integer`	The maximum number of results to return. Default: 100, Maximum: 2500

Action Authentication#

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

To retrieve your API Keys,