Submit Complete Plan Request with White Swan API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for White Swan, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Submit Complete Plan Request with the White Swan 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 White Swan 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 Submit Complete Plan Request action
1. Connect your White Swan account
2. Configure Name
3. Configure Email
4. Select a Policy Type
5. Select a Main Goal
6. Configure Resident State
7. Configure Death Benefit Needed
8. Select a Payment Schedule
9. Select a Gender
10. Configure Date of Birth
11. Select a Health Rating
12. Configure Uses Tobacco
13. Configure Insured Height in Feet
14. Configure Insured Height in Inches
15. Configure Insured Weight
16. Optional- Configure Pre-fill Info 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 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#

Submit Complete Plan Request on White Swan

Description:Creates a new comprehensive quote request based on the information provided and generates the final quotation without further data requirements. [See the documentation](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/action-calls/submit-complete-plan-request)

Version:0.0.2

Key:white_swan-submit-complete-plan-request

View on GitHub

White Swan Overview#

The White Swan API provides predictive analytics for mitigating risks in financial portfolios using artificial intelligence. By leveraging the White Swan API in Pipedream, you can automate the process of gathering insights, monitoring market conditions, and integrating advanced risk analysis into your existing financial systems. With Pipedream's serverless platform, you can construct workflows to react in real-time to data from White Swan, send alerts, and even automate trades or adjustments based on risk thresholds or predictive signals.

Action Code#

import whiteSwan from "../../white_swan.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "white_swan-submit-complete-plan-request",
  name: "Submit Complete Plan Request",
  description: "Creates a new comprehensive quote request based on the information provided and generates the final quotation without further data requirements. [See the documentation](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/action-calls/submit-complete-plan-request)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    whiteSwan,
    name: {
      type: "string",
      label: "Name",
      description: "The full name of the person who the request is made on behalf of.",
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the person who the request is made on behalf of.",
    },
    policyType: {
      type: "string",
      label: "Policy Type",
      description: "The policy type that this request is made for.",
      options: constants.POLICY_TYPE,
    },
    mainGoal: {
      type: "string",
      label: "Main Goal",
      description: "The primary goal of this plan request, either Protection or Accumulation.",
      options: constants.MAIN_GOAL,
    },
    residentState: {
      type: "string",
      label: "Resident State",
      description: "The state in which the insured person is a resident. Example: `California`",
    },
    deathBenefitNeeded: {
      type: "integer",
      label: "Death Benefit Needed",
      description: "The amount of death benefit that is required for this plan. To opt for the lowest amount possible given a certain premium budget, use 0.",
      default: 0,
    },
    paymentSchedule: {
      type: "string",
      label: "Payment Schedule",
      description: "How often premiums should be paid on this plan.",
      options: constants.PAYMENT_SCHEDULE,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Whether the intended insured person is Male or Female.",
      options: constants.GENDER,
    },
    dateOfBirth: {
      type: "string",
      label: "Date of Birth",
      description: "The date of birth of the intended insured person in ISO 8601 format.",
    },
    healthRating: {
      type: "string",
      label: "Health Rating",
      description: "How the insured person would rate their own general health.",
      options: constants.HEALTH_RATING,
    },
    usesTobacco: {
      type: "boolean",
      label: "Uses Tobacco",
      description: "Whether the intended insured person uses tobacco/nicotine products or not.",
    },
    insuredHeightFeet: {
      type: "integer",
      label: "Insured Height in Feet",
      description: "The height in feet of the intended insured person.",
    },
    insuredHeightInches: {
      type: "integer",
      label: "Insured Height in Inches",
      description: "The height in inches of the intended insured person.",
    },
    insuredWeight: {
      type: "integer",
      label: "Insured Weight",
      description: "The weight in pounds of the intended insured person.",
    },
    prefillInfoId: {
      type: "string",
      label: "Pre-fill Info ID",
      description: "If you have already created a pre-fill information you can pass its ID by using this parameter to associate that info with this request.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.whiteSwan.createQuoteRequest({
      $,
      data: {
        name: this.name,
        email: this.email,
        policy_type: this.policyType,
        main_goal: this.mainGoal,
        resident_state: this.residentState,
        death_benefit: this.deathBenefitNeeded,
        payment_schedule: this.paymentSchedule,
        gender: this.gender,
        date_of_birth: utils.convertISOToCustomFormat(this.dateOfBirth),
        health_rating: this.healthRating,
        tobacco: this.usesTobacco,
        height_feet: this.insuredHeightFeet,
        height_inches: this.insuredHeightInches,
        weight_pounds: this.insuredWeight,
        contact_id: this.prefillInfoId,
      },
    });
    $.export("$summary", "Successfully submitted complete plan request");
    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
White Swan	`whiteSwan`	`app`	This component uses the White Swan app.
Name	`name`	`string`	The full name of the person who the request is made on behalf of.
Email	`email`	`string`	The email of the person who the request is made on behalf of.
Policy Type	`policyType`	`string`	Select a value from the drop down menu:`Variable Universal LifeIndexed Universal LifeWhole LifeTerm LifeGuaranteed Universal LifePrivate Placement Life`
Main Goal	`mainGoal`	`string`	Select a value from the drop down menu:`AccumulationProtection`
Resident State	`residentState`	`string`	The state in which the insured person is a resident. Example: `California`
Death Benefit Needed	`deathBenefitNeeded`	`integer`	The amount of death benefit that is required for this plan. To opt for the lowest amount possible given a certain premium budget, use 0.
Payment Schedule	`paymentSchedule`	`string`	Select a value from the drop down menu:`MonthlyQuarterlyYearly`
Gender	`gender`	`string`	Select a value from the drop down menu:`MaleFemale`
Date of Birth	`dateOfBirth`	`string`	The date of birth of the intended insured person in ISO 8601 format.
Health Rating	`healthRating`	`string`	Select a value from the drop down menu:`AverageGoodExcellent`
Uses Tobacco	`usesTobacco`	`boolean`	Whether the intended insured person uses tobacco/nicotine products or not.
Insured Height in Feet	`insuredHeightFeet`	`integer`	The height in feet of the intended insured person.
Insured Height in Inches	`insuredHeightInches`	`integer`	The height in inches of the intended insured person.
Insured Weight	`insuredWeight`	`integer`	The weight in pounds of the intended insured person.
Pre-fill Info ID	`prefillInfoId`	`string`	If you have already created a pre-fill information you can pass its ID by using this parameter to associate that info with this request.

Action Authentication#

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

About White Swan#

White Swan’s digital platform and expert advisors makes it easy to get your clients any type of life insurance solution with the highest best-interest standards and most convenient experience.

More Ways to Connect White Swan + Pipedream#

Other Popular Integrations#

Create Pre-fill Info with White Swan API on New Scheduled Tasks from Pipedream API

Pipedream + White Swan

Submit Complete Plan Request with White Swan API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for White Swan, Pipedream and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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