Post Chat Completion with xAI API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Post Chat Completion with the xAI 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 xAI 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 Post Chat Completion action
1. Connect your xAI account
2. Select a Model
3. Configure Message
4. Optional- Configure Frequency Penalty
5. Optional- Configure Log Probabilities
6. Optional- Configure Max Tokens
7. Optional- Configure Completion Number
8. Optional- Configure Presence Penalty
9. Optional- Configure Seed
10. Optional- Configure Stream
11. Optional- Configure Temperature
12. Optional- Configure Nucleus Sampling
13. Optional- Configure User
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#

Post Chat Completion on xAI

Description:Create a language model response for a chat conversation. [See the documentation](https://docs.x.ai/api/endpoints#chat-completions)

Version:0.0.2

Key:x_ai-post-chat-completion

View on GitHub

Action Code#

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

export default {
  key: "x_ai-post-chat-completion",
  name: "Post Chat Completion",
  description: "Create a language model response for a chat conversation. [See the documentation](https://docs.x.ai/api/endpoints#chat-completions)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    model: {
      propDefinition: [
        app,
        "model",
      ],
    },
    message: {
      propDefinition: [
        app,
        "message",
      ],
    },
    frequencyPenalty: {
      propDefinition: [
        app,
        "frequencyPenalty",
      ],
    },
    logprobs: {
      propDefinition: [
        app,
        "logprobs",
      ],
    },
    maxTokens: {
      propDefinition: [
        app,
        "maxTokens",
      ],
    },
    n: {
      propDefinition: [
        app,
        "n",
      ],
    },
    presencePenalty: {
      propDefinition: [
        app,
        "presencePenalty",
      ],
    },
    seed: {
      propDefinition: [
        app,
        "seed",
      ],
    },
    stream: {
      propDefinition: [
        app,
        "stream",
      ],
    },
    temperature: {
      propDefinition: [
        app,
        "temperature",
      ],
    },
    topP: {
      propDefinition: [
        app,
        "topP",
      ],
    },
    user: {
      propDefinition: [
        app,
        "user",
      ],
    },
  },

  async run({ $ }) {
    const response = await this.app.postChatCompletion({
      $,
      data: {
        model: this.model,
        messages: [
          {
            role: "user",
            content: this.message,
          },
        ],
        frequency_penalty: Number(this.frequencyPenalty),
        logprobs: this.logprobs,
        max_tokens: this.maxTokens,
        n: this.n,
        presence_penalty: Number(this.presencePenalty),
        seed: this.seed,
        stream: this.stream,
        temperature: Number(this.temperature),
        top_p: Number(this.topP),
        user: this.user,
      },
    });
    $.export("$summary", `Successfully sent message to the model '${this.model}'`);
    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
xAI	`app`	`app`	This component uses the xAI app.
Model	`model`	`string`	Select a value from the drop down menu.
Message	`message`	`string`	Message for the chat completion
Frequency Penalty	`frequencyPenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim
Log Probabilities	`logprobs`	`boolean`	Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens
Max Tokens	`maxTokens`	`integer`	Limits the number of tokens that can be produced in the output
Completion Number	`n`	`integer`	Determines how many completion sequences to produce for each prompt. Be cautious with its use due to high token consumption
Presence Penalty	`presencePenalty`	`string`	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics
Seed	`seed`	`integer`	If specified, our system will make a best effort to sample deterministically
Stream	`stream`	`boolean`	Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available
Temperature	`temperature`	`string`	What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic
Nucleus Sampling	`topP`	`string`	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered
User	`user`	`string`	A unique identifier representing your end-user, which can help xAI to monitor and detect abuse