List subscribers with ConvertKit API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for ConvertKit, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

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

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the List subscribers action
1. Connect your ConvertKit account
2. Optional- Configure Email address
3. Optional- Configure Page
4. Optional- Configure Start date
5. Optional- Configure End date
6. Optional- Select a Sort order
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

List subscribers on ConvertKit

Description:Returns a list of your subscribers. [See docs here](https://developers.convertkit.com/#list-subscribers)

Version:0.0.2

Key:convertkit-list-subscribers

View on GitHub

ConvertKit Overview#

ConvertKit's API offers granular control over email marketing campaigns, allowing users to automate subscriber management, broadcast sending, and sequence setup. Utilize Pipedream's power to react to events, sync data across platforms, or create personalized, timely campaigns. Pipedream's serverless platform connects ConvertKit with hundreds of other apps, enabling automated workflows that save time and improve engagement.

Action Code#

import convertkit from "../../convertkit.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "convertkit-list-subscribers",
  name: "List subscribers",
  description: "Returns a list of your subscribers. [See docs here](https://developers.convertkit.com/#list-subscribers)",
  version: "0.0.2",
  type: "action",
  props: {
    convertkit,
    emailAddress: {
      label: "Email address",
      description: "Search subscribers by email address",
      type: "string",
      optional: true,
    },
    page: {
      label: "Page",
      description: "Page for paginated results",
      type: "integer",
      default: 1,
      optional: true,
    },
    from: {
      label: "Start date",
      description: "Filter subscribers added on or after this date (format yyyy-mm-dd)",
      type: "string",
      optional: true,
    },
    to: {
      label: "End date",
      description: "Filter subscribers added on or before this date (format yyyy-mm-dd)",
      type: "string",
      optional: true,
    },
    sortOrder: {
      label: "Sort order",
      description: "Sort order for results",
      type: "string",
      default: constants.SORT_ORDER[0],
      options: constants.SORT_ORDER,
      optional: true,
    },
  },
  async run({ $ }) {
    const payload = {
      email_address: this.emailAddress,
      page: this.page,
      from: this.from,
      to: this.to,
      sort_order: this.sortOrder,
    };
    const data = [];
    const paginator = this.convertkit.paginate({
      $,
      fn: this.convertkit.listSubscribers,
      payload,
    }, "subscribers");
    for await (const item of paginator) {
      data.push(item);
    }
    if (data.length) {
      $.export("$summary", "Successfully listed subscribers");
    }
    return data;
  },
};

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
ConvertKit	`convertkit`	`app`	This component uses the ConvertKit app.
Email address	`emailAddress`	`string`	Search subscribers by email address
Page	`page`	`integer`	Page for paginated results
Start date	`from`	`string`	Filter subscribers added on or after this date (format yyyy-mm-dd)
End date	`to`	`string`	Filter subscribers added on or before this date (format yyyy-mm-dd)
Sort order	`sortOrder`	`string`	Select a value from the drop down menu:`ascdesc`

Action Authentication#

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

All API calls require the api_key parameter. Some API calls require the api_secret parameter. You can find your API Key and Secret in the ConvertKit Account page. See documentation.

About ConvertKit#

Email Marketing for Online Creators

More Ways to Connect ConvertKit + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Subscriber Activation (Instant) from ConvertKit API

ConvertKit + HTTP / Webhook