Place Order with Alpaca API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Place Order with the Alpaca 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 Alpaca 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 Place Order action
1. Connect your Alpaca account
2. Optional- Configure Paper API
3. Configure Symbol
4. Optional- Configure Qty
5. Optional- Configure Notional
6. Select a Side
7. Select a Type
8. Select a Time in Force
9. Optional- Configure Limit Price
10. Optional- Configure Stop Price
11. Optional- Configure Trail Price
12. Optional- Configure Trail Percent
13. Optional- Configure Extended Hours
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#

Place Order on Alpaca

Description:Places a new order for the given account. An order request may be rejected if the account is not authorized for trading, or if the tradable balance is insufficient to fill the order, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#request-a-new-order)

Version:0.1.0

Key:alpaca-place-order

View on GitHub

Alpaca Overview#

Alpaca API allows you to harness the power of automated trading by providing an interface to manage your stock and equity portfolio through simple API calls. It's particularly suited for building trading bots, algorithmic trading strategies, or just automating interactions with your investment portfolio. Whether you're looking to place trades based on specific market conditions, automatically adjust your portfolio in response to certain triggers, or simply streamline your investment activities, Alpaca's trading API offers a robust solution.

Action Code#

import app from "../../alpaca.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  type: "action",
  key: "alpaca-place-order",
  version: "0.1.0",
  name: "Place Order",
  description: "Places a new order for the given account. An order request may be rejected if the account is not authorized for trading, or if the tradable balance is insufficient to fill the order, [See the docs](https://alpaca.markets/docs/api-references/trading-api/orders/#request-a-new-order)",
  props: {
    app,
    isPaperAPI: {
      propDefinition: [
        app,
        "isPaperAPI",
      ],
    },
    symbol: {
      type: "string",
      label: "Symbol",
      description: "Symbol, asset ID, or currency pair to identify the asset to trade (ex. `AAPL`, `BTC/USD`).",
    },
    qty: {
      type: "string",
      label: "Qty",
      description: "Number of shares to trade. Can be fractionable for only `market` and `day` order types.",
      optional: true,
    },
    notional: {
      type: "string",
      label: "Notional",
      description: "Dollar amount to trade. Cannot work with `Qty`. Can only work for `market` order types and `day` for time in force.",
      optional: true,
    },
    side: {
      propDefinition: [
        app,
        "side",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "Type",
      options: [
        "market",
        "limit",
        "stop",
        "stop_limit",
        "trailing_stop",
      ],
    },
    timeInForce: {
      type: "string",
      label: "Time in Force",
      description: "Please see [this doc](https://alpaca.markets/docs/trading/orders/#time-in-force) for more info on what values are possible for what kind of orders.",
      options: [
        "day",
        "gtc",
        "opg",
        "cls",
        "ioc",
        "fok",
      ],
    },
    limitPrice: {
      type: "string",
      label: "Limit Price",
      description: "Required if type is `limit` or `stop_limit`",
      optional: true,
    },
    stopPrice: {
      type: "string",
      label: "Stop Price",
      description: "Required if type is `stop` or `stop_limit`",
      optional: true,
    },
    trailPrice: {
      type: "string",
      label: "Trail Price",
      description: "This or `trail_percent` is required if type is `trailing_stop`",
      optional: true,
    },
    trailPercent: {
      type: "string",
      label: "Trail Percent",
      description: "This or `trail_price` is required if type is `trailing_stop`",
      optional: true,
    },
    extendedHours: {
      type: "boolean",
      label: "Extended Hours",
      description: "If true, order will be eligible to execute in premarket/afterhours. Only works with `Type` **Limit** and `Time in Force` **Day**.",
      optional: true,
      default: false,
    },
  },
  async run ({ $ }) {
    if (!this.qty && !this.notional) {
      throw new ConfigurationError("Either `Qty` or `Notional` is required!");
    }
    if (this.qty && this.notional) {
      throw new ConfigurationError("`Qty` and `Notional` cannot be given at the same time!");
    }
    if ((this.type == "limit" || this.type == "stop_limit") && !this.limitPrice) {
      throw new ConfigurationError("`Limit Price` is required when `Type` is `limit` or `stop_limit`!");
    }
    if ((this.type == "stop" || this.type == "stop_limit") && !this.stopPrice) {
      throw new ConfigurationError("`Stop Price` is required when `Type` is `limit` or `stop_limit`!");
    }
    if (this.type == "trailing_stop" && !this.trailPrice && !this.trailPercent) {
      throw new ConfigurationError("`Trail Price` or `Trail Percent` is required when `Type` is `trailing_stop`!");
    }
    const response = await this.app.placeOrder({
      $,
      isPaperAPI: this.isPaperAPI,
      data: {
        symbol: this.symbol,
        qty: this.qty,
        notional: this.notional,
        side: this.side,
        type: this.type,
        time_in_force: this.timeInForce,
        limit_price: this.limitPrice,
        stop_price: this.stopPrice,
        trail_price: this.trailPrice,
        trail_percent: this.trailPercent,
        extended_hours: this.extendedHours,
      },
    });
    $.export("$summary", `Order(ID:${response.id}) has been placed.`);
    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
Alpaca	`app`	`app`	This component uses the Alpaca app.
Paper API	`isPaperAPI`	`boolean`	Set to `true` if Paper API is used. Default is `false`.
Symbol	`symbol`	`string`	Symbol, asset ID, or currency pair to identify the asset to trade (ex. `AAPL`, `BTC/USD`).
Qty	`qty`	`string`	Number of shares to trade. Can be fractionable for only `market` and `day` order types.
Notional	`notional`	`string`	Dollar amount to trade. Cannot work with `Qty`. Can only work for `market` order types and `day` for time in force.
Side	`side`	`string`	Select a value from the drop down menu:`buysell`
Type	`type`	`string`	Select a value from the drop down menu:`marketlimitstopstop_limittrailing_stop`
Time in Force	`timeInForce`	`string`	Select a value from the drop down menu:`daygtcopgclsiocfok`
Limit Price	`limitPrice`	`string`	Required if type is `limit` or `stop_limit`
Stop Price	`stopPrice`	`string`	Required if type is `stop` or `stop_limit`
Trail Price	`trailPrice`	`string`	This or `trail_percent` is required if type is `trailing_stop`
Trail Percent	`trailPercent`	`string`	This or `trail_price` is required if type is `trailing_stop`
Extended Hours	`extendedHours`	`boolean`	If true, order will be eligible to execute in premarket/afterhours. Only works with `Type` Limit and `Time in Force` Day.

Action Authentication#

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

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

account:writetradingdata