List Responses with Typeform API on New Transactional Webhook (Instant) from SendinBlue API

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

Trigger workflow on

New Transactional Webhook (Instant) from the SendinBlue API

Next, do this

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

Select this integration
Configure the New Transactional Webhook (Instant) trigger
1. Connect your SendinBlue account
2. Configure Description
3. Select one or more Events
Configure the List Responses action
1. Connect your Typeform account
2. Select a Form
3. Optional- Configure Page size
4. Optional- Configure Since
5. Optional- Configure Until
6. Optional- Configure After
7. Optional- Configure Before
8. Optional- Select one or more Included response IDs
9. Optional- Select one or more Excluded response IDs
10. Optional- Configure Completed
11. Optional- Configure Sort
12. Optional- Configure Query
13. Optional- Select one or more Fields
14. Optional- Select one or more Answered fields
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 Transactional Webhook (Instant) on SendinBlue

Description:Emit new event when triggered by a transactional event

Version:0.0.1

Key:sendinblue-transactional-webhook

View on GitHub

SendinBlue Overview#

The SendinBlue API offers a suite of email marketing tools, including campaign creation, contact list management, and transactional email sending. It's designed for crafting personalized messages, automating marketing workflows, and tracking the performance of email campaigns. With Pipedream, you can harness the power of SendinBlue by automating interactions with other services, reacting to events with custom code, and stitching together complex workflows with minimal effort.

Trigger Code#

import common from "../common-webhook.mjs";
import options from "../../common/options.mjs";

export default {
  ...common,
  key: "sendinblue-transactional-webhook",
  name: "New Transactional Webhook (Instant)",
  description: "Emit new event when triggered by a transactional event",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    description: {
      type: "string",
      label: "Description",
      description: "Description of the webhook.",
    },
    events: {
      type: "string[]",
      label: "Events",
      description: "Events triggering the webhook.",
      options: options.transactionalEventOptions,
    },
  },
  methods: {
    ...common.methods,
    getEventNames() {
      return this.events;
    },
    getHookDescription() {
      return this.description;
    },
    getEventType() {
      return "transactional";
    },
    generateMeta(body) {
      const meta = {
        ...body,
      };
      return meta;
    },
  },
};

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
SendinBlue	`sendinBlueApp`	`app`	This component uses the SendinBlue 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.
Description	`description`	`string`	Description of the webhook.
Events	`events`	`string[]`	Select a value from the drop down menu:`sentdeliveredhardBouncesoftBounceblockedspaminvaliddeferredclickopeneduniqueOpenedunsubscribed`

Trigger Authentication#

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

Get your API key under SMTP & API

About SendinBlue#

Sendinblue powers advanced email marketing and automation

Action#

List Responses on Typeform

Description:Returns form responses and date and time of form landing and submission. [See the docs here](https://developer.typeform.com/responses/reference/retrieve-responses/)

Version:0.0.2

Key:typeform-list-responses

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.

Action Code#

import typeform from "../../typeform.app.mjs";
import utils from "../utils.mjs";
import constants from "../../constants.mjs";

const { commaSeparatedList } = utils;

export default {
  key: "typeform-list-responses",
  name: "List Responses",
  description: "Returns form responses and date and time of form landing and submission. [See the docs here](https://developer.typeform.com/responses/reference/retrieve-responses/)",
  type: "action",
  version: "0.0.2",
  props: {
    typeform,
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
    pageSize: {
      propDefinition: [
        typeform,
        "pageSize",
      ],
    },
    since: {
      propDefinition: [
        typeform,
        "since",
      ],
    },
    until: {
      propDefinition: [
        typeform,
        "until",
      ],
    },
    after: {
      propDefinition: [
        typeform,
        "after",
      ],
    },
    before: {
      propDefinition: [
        typeform,
        "before",
      ],
    },
    includedResponseIds: {
      type: "string[]",
      label: "Included response IDs",
      description: "Limit request to the specified `response_id` values. Use a comma-separated list to specify more than one `response_id` value. Please bear in mind that if you set a list of included response ids you won't be able to use the list of excluded response ids",
      optional: true,
      propDefinition: [
        typeform,
        "responseId",
        ({
          page, formId,
        }) => ({
          page,
          formId,
        }),
      ],
    },
    excludedResponseIds: {
      type: "string[]",
      label: "Excluded response IDs",
      description: "Comma-separated list of `response_ids` to be excluded from the response. Please bear in mind that if you set a list of excluded response ids you won't be able to use the list of included response ids",
      optional: true,
      propDefinition: [
        typeform,
        "responseId",
        ({
          page, formId,
        }) => ({
          page,
          formId,
        }),
      ],
    },
    completed: {
      type: "boolean",
      label: "Completed",
      description: "Limit responses only to those which were submitted. This parameter changes `since`/`until` filter, so if `completed=true`, it will filter by `submitted_at`, otherwise - `landed_at`.",
      optional: true,
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "Responses order in `{fieldID},{asc|desc}` format. You can use built-in `submitted_at`/`landed_at` field IDs or any field ID from your typeform, possible directions are `asc`/`desc`. Default value is `submitted_at,desc`.",
      optional: true,
      default: `${constants.RESPONSE_FIELDS.SUBMITTED_AT},desc`,
    },
    query: {
      optional: true,
      propDefinition: [
        typeform,
        "query",
      ],
    },
    fields: {
      type: "string[]",
      label: "Fields",
      description: "Show only specified fields in answers section. If response does not have answers for specified fields, there will be `null`. Use a comma-separated list to specify more than one field value.",
      optional: true,
      propDefinition: [
        typeform,
        "fieldId",
        ({ formId }) => ({
          formId,
        }),
      ],
    },
    answeredFields: {
      type: "string[]",
      label: "Answered fields",
      description: "Limit request to only responses that include the specified fields in answers section. Use a comma-separated list to specify more than one field value - response will contain at least one of the specified fields.",
      optional: true,
      propDefinition: [
        typeform,
        "fieldId",
        ({ formId }) => ({
          formId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      formId,
      pageSize,
      since,
      until,
      after,
      before,
      includedResponseIds,
      excludedResponseIds,
      completed,
      sort,
      query,
      fields,
      answeredFields,
    } = this;

    const params = {
      page_size: pageSize,
      since,
      until,
      after,
      before,
      included_response_ids: commaSeparatedList(includedResponseIds),
      excluded_response_ids: commaSeparatedList(excludedResponseIds),
      completed,
      sort: completed === false
        ? constants.RESPONSE_FIELDS.LANDED_AT
        : sort,
      query,
      fields: commaSeparatedList(fields),
      answered_fields: commaSeparatedList(answeredFields),
    };

    const { items } = await this.typeform.getResponses({
      $,
      formId,
      params,
    });

    // eslint-disable-next-line multiline-ternary
    $.export("$summary", `Successfully listed ${items.length} ${items.length == 1 ? "response" : "responses"}`);

    return items;
  },
};

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
Typeform	`typeform`	`app`	This component uses the Typeform app.
Form	`formId`	`string`	Select a value from the drop down menu.
Page size	`pageSize`	`integer`	Maximum number of responses. Maximum value is 1000. If your typeform has more than 1000 responses, use the `since`/`until` or `before`/`after` parameters to narrow the scope of your request.
Since	`since`	`string`	Limit request to responses submitted since the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with `T` as a delimiter between the date and time (`2020-03-20T14:00:59`).
Until	`until`	`string`	Limit request to responses submitted until the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with `T` as a delimiter between the date and time (`2020-03-20T14:00:59`).
After	`after`	`string`	Limit request to responses submitted after the specified token. Could not be used together with `sort` parameter, as it sorts responses in the order that the system processed them (`submitted_at`). This ensures that you can traverse the complete set of responses without repeating entries.
Before	`before`	`string`	Limit request to responses submitted before the specified token. Could not be used together with `sort` parameter, as it sorts responses in the order that the system processed them (`submitted_at`). This ensures that you can traverse the complete set of responses without repeating entries.
Included response IDs	`includedResponseIds`	`string[]`	Select a value from the drop down menu.
Excluded response IDs	`excludedResponseIds`	`string[]`	Select a value from the drop down menu.
Completed	`completed`	`boolean`	Limit responses only to those which were submitted. This parameter changes `since`/`until` filter, so if `completed=true`, it will filter by `submitted_at`, otherwise - `landed_at`.
Sort	`sort`	`string`	Responses order in `{fieldID},{asc\|desc}` format. You can use built-in `submitted_at`/`landed_at` field IDs or any field ID from your typeform, possible directions are `asc`/`desc`. Default value is `submitted_at,desc`.
Query	`query`	`string`	Limit request to only responses that include the specified string. The string will be escaped and it will be matched against all answers fields, hidden fields and variables values.
Fields	`fields`	`string[]`	Select a value from the drop down menu.
Answered fields	`answeredFields`	`string[]`	Select a value from the drop down menu.

Action 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