Add or Update a Subscriber with Sendy API on New Webhook Event (Instant) from ConvertKit API

Pipedream makes it easy to connect APIs for Sendy, ConvertKit and 2,500+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the ConvertKit API

Next, do this

Add or Update a Subscriber with the Sendy 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 ConvertKit trigger and Sendy action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your ConvertKit account
2. Select a Webhook Events
Configure the Add or Update a Subscriber action
1. Connect your Sendy account
2. Select a Brand ID
3. Select a List ID
4. Configure Email
5. Optional- Configure Name
6. Optional- Configure Country
7. Optional- Configure IP Address
8. Optional- Configure Referrer
9. Optional- Configure GDPR
10. Optional- Configure silent
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 Webhook Event (Instant) on ConvertKit

Description:Emit new event for each selected event types. [See docs here](https://developers.convertkit.com/#create-a-webhook)

Version:0.0.2

Key:convertkit-webhook-events

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.

Trigger Code#

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

export default {
  ...common,
  key: "convertkit-webhook-events",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each selected event types. [See docs here](https://developers.convertkit.com/#create-a-webhook)",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    event: {
      label: "Webhook Events",
      description: "The event will be emitted",
      type: "string",
      options: constants.WEBHOOK_EVENTS.map(({
        value, label,
      }) => ({
        value,
        label,
      })),
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    const optionalProps = constants.WEBHOOK_EVENTS
      .find((ev) => this.event === ev.value)?.additionalProps;
    if (optionalProps?.includes("form")) {
      props.form = {
        type: "integer",
        label: "Form",
        description: "Select a form",
        options: async () => {
          const response = await this.convertkit.listForms();
          return response.forms.map((form) => ({
            label: form.name,
            value: form.id,
          }));
        },
      };
    } else if (optionalProps?.includes("course")) {
      props.course = {
        type: "integer",
        label: "Course",
        description: "Select a course",
        options: async () => {
          const response = await this.convertkit.listCourses();
          return response.courses.map((course) => ({
            label: course.name,
            value: course.id,
          }));
        },
      };
    } else if (optionalProps?.includes("initiator")) {
      props.link = {
        type: "string",
        label: "Link",
        description: "link URL",
      };
    } else if (optionalProps?.includes("tag")) {
      props.tag = {
        type: "integer",
        label: "Tag",
        description: "Select a tag",
        options: async () => {
          const response = await this.convertkit.listTags();
          return response.tags.map((tag) => ({
            label: tag.name,
            value: tag.id,
          }));
        },
      };
    }
    return props;
  },
  methods: {
    ...common.methods,
    getWebhookEventTypes() {
      return {
        name: this.event,
        form_id: this.form,
        course_id: this.course,
        initiator_value: this.link,
        tag_id: this.tag,
      };
    },
    async processEvent(event) {
      const {
        headers,
        body,
      } = event;

      this.$emit(body, {
        id: headers.tracestate,
        summary: `New event of type ${constants.WEBHOOK_EVENTS
          .find((ev) => this.event === ev.value).label}`,
        ts: new Date().getTime(),
      });
    },
  },
};

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
ConvertKit	`convertkit`	`app`	This component uses the ConvertKit app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Webhook Events	`event`	`string`	Select a value from the drop down menu:`{ "value": "subscriber.form_subscribe", "label": "On form subscription" }{ "value": "subscriber.course_subscribe", "label": "On course subscription" }{ "value": "subscriber.course_complete", "label": "On course completion" }{ "value": "subscriber.link_click", "label": "On link clicked" }{ "value": "subscriber.tag_add", "label": "On tag added" }{ "value": "subscriber.tag_remove", "label": "On tag removed" }{ "value": "purchase.purchase_create", "label": "On purchase created" }`

Trigger 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

Action#

Add or Update a Subscriber on Sendy

Description:Adds a new subscriber or updates existing subscriber's details for a specific list. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#subscribe)

Version:0.0.1

Key:sendy-add-update-subscriber

View on GitHub

Sendy Overview#

The Sendy API allows you to programmatically manage email campaigns, subscribers, and lists. With Pipedream's capabilities, you can leverage Sendy API to create custom workflows that respond to events, synchronize data across platforms, and automate email marketing tasks. Pipedream provides a serverless platform where you can connect Sendy with hundreds of other apps without writing complex code, harnessing the power of Sendy's features with event-driven programming and API integration.

Action Code#

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

export default {
  key: "sendy-add-update-subscriber",
  name: "Add or Update a Subscriber",
  description: "Adds a new subscriber or updates existing subscriber's details for a specific list. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#subscribe)",
  version: "0.0.1",
  type: "action",
  props: {
    sendy,
    brandId: {
      propDefinition: [
        sendy,
        "brandId",
      ],
    },
    list: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
    },
    email: {
      propDefinition: [
        sendy,
        "email",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The user's name.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "user's [2 letter country code](https://datahub.io/core/country-list#resource-data).",
      optional: true,
    },
    ipaddress: {
      type: "string",
      label: "IP Address",
      description: "The user's IP address.",
      optional: true,
    },
    referrer: {
      type: "string",
      label: "Referrer",
      description: "The URL where the user signed up from.",
      optional: true,
    },
    gdpr: {
      type: "boolean",
      label: "GDPR",
      description: "If you're signing up EU users in a GDPR compliant manner, set this to true.",
      optional: true,
    },
    silent: {
      type: "boolean",
      label: "silent",
      description: "Set to True if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead'",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      sendy,
      ...data
    } = this;

    const response = await sendy.addOrUpdateSubscriber({
      $,
      data: {
        ...data,
        boolean: true,
      },
    });

    $.export("$summary", `Successfully ${response === 1
      ? "added"
      : "updated"} the subscriber with email: ${this.email}`);
    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
Sendy	`sendy`	`app`	This component uses the Sendy app.
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
List ID	`list`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The email address of the subscriber.
Name	`name`	`string`	The user's name.
Country	`country`	`string`	user's 2 letter country code
IP Address	`ipaddress`	`string`	The user's IP address.
Referrer	`referrer`	`string`	The URL where the user signed up from.
GDPR	`gdpr`	`boolean`	If you're signing up EU users in a GDPR compliant manner, set this to true.
silent	`silent`	`boolean`	Set to True if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead'

Action Authentication#

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