Create Send with Twilio SendGrid API on New Author from Ghost.org (Content API) API

Pipedream makes it easy to connect APIs for Twilio SendGrid, Ghost.org (Content API) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Author from the Ghost.org (Content API) API

Next, do this

Create Send with the Twilio SendGrid 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 Ghost.org (Content API) trigger and Twilio SendGrid action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Author trigger
1. Connect your Ghost.org (Content API) account
2. Configure Polling schedule
Configure the Create Send action
1. Connect your Twilio SendGrid account
2. Configure Name
3. Optional- Select one or more Categories
4. Optional- Configure Send At
5. Optional- Select one or more List Ids
6. Optional- Select one or more Segment Ids
7. Configure All
8. Optional- Configure Subject
9. Optional- Configure HTML Content
10. Optional- Configure Plain Content
11. Optional- Configure Generate Plain Content
12. Optional- Select a Design Id
13. Optional- Select a Editor
14. Optional- Select a ASM Group ID
15. Optional- Configure Custom Unsubscribe URL
16. Optional- Select a Sender Id
17. Optional- Configure IP Pool
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 Author on Ghost.org (Content API)

Description:Emit new event for each new author added on a site.

Version:0.0.4

Key:ghost_org_content_api-new-author

View on GitHub

Ghost.org (Content API) Overview#

The Ghost.org (Content API) unlocks the power of content automation and integration for developers and content creators. With this API, you can programmatically access and manipulate your blog's posts, tags, authors, and settings. It's perfect for streamlining content workflows, from syncing with other platforms to analyzing and optimizing your content strategy.

Trigger Code#

import constants from "../../common/constants.mjs";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  type: "source",
  key: "ghost_org_content_api-new-author",
  name: "New Author",
  description: "Emit new event for each new author added on a site.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.ghostContentApi.getAuthors;
    },
    getResourceFnArgs() {
      return {
        params: {
          limit: constants.DEFAULT_LIMIT,
        },
      };
    },
    getResourceName() {
      return "authors";
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        ts: Date.now(),
        summary: `Author ID ${resource.id}`,
      };
    },
  },
};

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
Ghost.org (Content API)	`ghostContentApi`	`app`	This component uses the Ghost.org (Content API) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the Ghost API

Trigger Authentication#

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

About Ghost.org (Content API)#

Open source publishing platform

Action#

Create Send on Twilio SendGrid

Description:Create a single send. [See the docs here](https://www.twilio.com/docs/sendgrid/api-reference/single-sends/create-single-send)

Version:0.0.1

Key:sendgrid-create-send

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "sendgrid-create-send",
  name: "Create Send",
  description: "Create a single send. [See the docs here](https://www.twilio.com/docs/sendgrid/api-reference/single-sends/create-single-send)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the Single Send.",
    },
    categoryIds: {
      propDefinition: [
        common.props.sendgrid,
        "categoryIds",
      ],
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "Set this property to an ISO 8601 formatted date-time (YYYY-MM-DDTHH:MM:SSZ) when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [Schedule Single Send](https://www.twilio.com/docs/sendgrid/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Setting this property to `now` with this endpoint will cause an error.",
      optional: true,
    },
    listIds: {
      propDefinition: [
        common.props.sendgrid,
        "listIds",
      ],
      description: "The recipient List IDs that will receive the Single Send.",
      optional: true,
      hidden: true,
    },
    segmentIds: {
      propDefinition: [
        common.props.sendgrid,
        "segmentIds",
      ],
      optional: true,
      hidden: true,
    },
    all: {
      type: "boolean",
      label: "All",
      description: "Set to `true` to send to All Contacts. If set to `false`, at least one `List Ids` or `Segment Ids` value must be provided before the Single Send is scheduled to be sent to recipients.",
      default: true,
      reloadProps: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject line of the Single Send. Do not include this field when using a `Design Id`.",
      optional: true,
    },
    htmlContent: {
      type: "string",
      label: "HTML Content",
      description: "The HTML content of the Single Send. Do not include this field when using a `Design Id`.",
      optional: true,
    },
    plainContent: {
      type: "string",
      label: "Plain Content",
      description: "The plain text content of the Single Send. Do not include this field when using a `Design Id`.",
      optional: true,
    },
    generatePlainContent: {
      type: "boolean",
      label: "Generate Plain Content",
      description: "If set to `true`, `Plain Content` is always generated from `HTML Content`. If set to false, `Plain Content` is not altered.",
      optional: true,
    },
    designId: {
      propDefinition: [
        common.props.sendgrid,
        "designId",
      ],
      optional: true,
    },
    editor: {
      type: "string",
      label: "Editor",
      description: "The editor is used to modify the Single Send's design in the Marketing Campaigns App.",
      options: [
        "design",
        "code",
      ],
      optional: true,
    },
    suppressionGroupId: {
      propDefinition: [
        common.props.sendgrid,
        "asmGroupId",
      ],
      optional: true,
    },
    customUnsubscribeUrl: {
      type: "string",
      label: "Custom Unsubscribe URL",
      description: "The URL allowing recipients to unsubscribe — you must provide this or the `Suppression Group Id`.",
      optional: true,
    },
    senderId: {
      propDefinition: [
        common.props.sendgrid,
        "senderId",
      ],
      optional: true,
    },
    ipPool: {
      type: "string",
      label: "IP Pool",
      description: "The name of the IP Pool from which the Single Send emails are sent.",
      optional: true,
    },
  },
  async additionalProps(props) {
    props.listIds.hidden = this.all;
    props.segmentIds.hidden = this.all;
    return {};
  },
  async run({ $ }) {
    if (!this.suppressionGroupId && !this.customUnsubscribeUrl) {
      throw new ConfigurationError("You must provide either `ASM Group ID` or the `Custom Unsubscribe URL`.");
    }
    try {
      const resp = await this.sendgrid.createSingleSend({
        $,
        data: {
          name: this.name,
          categories: parseObject(this.categoryIds),
          send_at: this.sendAt,
          send_to: {
            list_ids: !this.all
              ? parseObject(this.listIds)
              : null,
            segment_ids: !this.all
              ? parseObject(this.segmentIds)
              : null,
            all: this.all,
          },
          email_config: {
            subject: this.subject,
            html_content: this.htmlContent,
            plain_content: this.plainContent,
            generate_plain_content: this.generatePlainContent,
            design_id: this.designId,
            editor: this.editor,
            suppression_group_id: this.suppressionGroupId,
            custom_unsubscribe_url: this.customUnsubscribeUrl,
            sender_id: this.senderId,
            ip_pool: this.ipPool,
          },
        },
      });
      $.export("$summary", `Successfully created single send ${this.name}`);
      return resp;
    } catch (e) {
      const errors = e.split("Unexpected error (status code: ERR_BAD_REQUEST):")[1];
      const errorJson = JSON.parse(errors);

      throw new ConfigurationError(errorJson.data.errors[0].message);
    }
  },
};

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
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
Name	`name`	`string`	The name of the Single Send.
Categories	`categoryIds`	`string[]`	Select a value from the drop down menu.
Send At	`sendAt`	`string`	Set this property to an ISO 8601 formatted date-time (YYYY-MM-DDTHH:MM:SSZ) when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the Schedule Single Send endpoint or SendGrid application UI. Setting this property to `now` with this endpoint will cause an error.
All	`all`	`boolean`	Set to `true` to send to All Contacts. If set to `false`, at least one `List Ids` or `Segment Ids` value must be provided before the Single Send is scheduled to be sent to recipients.
Subject	`subject`	`string`	The subject line of the Single Send. Do not include this field when using a `Design Id`.
HTML Content	`htmlContent`	`string`	The HTML content of the Single Send. Do not include this field when using a `Design Id`.
Plain Content	`plainContent`	`string`	The plain text content of the Single Send. Do not include this field when using a `Design Id`.
Generate Plain Content	`generatePlainContent`	`boolean`	If set to `true`, `Plain Content` is always generated from `HTML Content`. If set to false, `Plain Content` is not altered.
Design Id	`designId`	`string`	Select a value from the drop down menu.
Editor	`editor`	`string`	Select a value from the drop down menu:`designcode`
ASM Group ID	`suppressionGroupId`	`integer`	Select a value from the drop down menu.
Custom Unsubscribe URL	`customUnsubscribeUrl`	`string`	The URL allowing recipients to unsubscribe — you must provide this or the `Suppression Group Id`.
Sender Id	`senderId`	`string`	Select a value from the drop down menu.
IP Pool	`ipPool`	`string`	The name of the IP Pool from which the Single Send emails are sent.