Upload Image with ImageKit.io API on New Author from Ghost.org (Content API) API

Pipedream makes it easy to connect APIs for ImageKit.io, Ghost.org (Content API) and 2,900+ other apps remarkably fast.

Trigger workflow on

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

Next, do this

Upload Image with the ImageKit.io 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 ImageKit.io 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 Upload Image action
1. Connect your ImageKit.io account
2. Configure File Path or URL
3. Configure File Name
4. Optional- Configure Use Unique Filename
5. Optional- Configure Tags
6. Optional- Configure Folder
7. Optional- Configure Is Private File
8. Optional- Configure Is Published
9. Optional- Configure Custom Coordinates
10. Optional- Configure Response Fields
11. Optional- Configure Extensions
12. Optional- Configure Webhook URL
13. Optional- Configure Overwrite File
14. Optional- Configure Overwrite AI Tags
15. Optional- Configure Overwrite Custom Metadata
16. Optional- Configure customMetadata
17. Optional- Configure syncDir
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#

Upload Image on ImageKit.io

Description:Upload a new image to ImageKit.io. [See the documentation](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload)

Version:1.0.2

Key:imagekit_io-upload-image

View on GitHub

ImageKit.io Overview#

ImageKit.io API lets you manage, optimize, and deliver images dynamically for your web applications. On Pipedream, you can integrate this API to construct serverless workflows that automate your image operations and connect with other services. You can upload images from various sources, apply real-time transformations, and track media assets without managing infrastructure.

Action Code#

import {
  fieldToString,
  getFileFormData,
} from "../../common/methods.mjs";
import imagekitIo from "../../imagekit_io.app.mjs";

export default {
  key: "imagekit_io-upload-image",
  name: "Upload Image",
  version: "1.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Upload a new image to ImageKit.io. [See the documentation](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload)",
  type: "action",
  props: {
    imagekitIo,
    file: {
      type: "string",
      label: "File Path or URL",
      description: "The file to upload. Provide a file URL or a path to a file in the `/tmp` directory. This can be a binary file or a base64-encoded string.",
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "The name with which the file has to be uploaded. The file name can contain: - Alphanumeric Characters: **a-z , A-Z , 0-9** (including unicode letters, marks, and numerals in other languages) - Special Characters: **.** and **-** Any other character including space will be replaced by **_**",
    },
    useUniqueFileName: {
      type: "boolean",
      label: "Use Unique Filename",
      description: "Whether to use a unique filename for this file or not. If set **true**, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. If set **false**, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. Default Value is **True**",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Set the tags while uploading the file. `%` is not allowed. If this field is not specified and the file is overwritten then the tags will be removed.",
      optional: true,
    },
    folder: {
      type: "string",
      label: "Folder",
      description: "The folder path **(e.g. /images/folder/)** in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. The nesting of folders can be at most 50 levels deep. The folder name can contain: - Alphanumeric Characters: **a-z , A-Z , 0-9** (including unicode letters, marks, and numerals in other languages). - Special Characters: **/**, **_** and **-**. - Using multiple / creates a nested folder.",
      optional: true,
    },
    isPrivateFile: {
      type: "boolean",
      label: "Is Private File",
      description: "Whether to mark the file as private or not. This is only relevant for image type files.",
      optional: true,
    },
    isPublished: {
      type: "boolean",
      label: "Is Published",
      description: "Whether to upload file as published or not. If set **false**, the file is marked as unpublished, which restricts access to the file only via the media library. Files in [draft or unpublished](https://docs.imagekit.io/media-library/overview/draft-assets) state can only be publicly accessed after being published. - The option to upload in draft state is only available in custom enterprise pricing plans.",
      optional: true,
    },
    customCoordinates: {
      type: "string",
      label: "Custom Coordinates",
      description: "Define an important area in the image. This is only relevant for image type files. The the format **x,y,width,height**. For example - **10,10,100,100**.",
      optional: true,
    },
    responseFields: {
      type: "string[]",
      label: "Response Fields",
      description: "A list of the fields that you want the API to return in the response. For example, set the value of this field to **tags**, **customCoordinates**, **isPrivateFile** to get the value of **tags**, **customCoordinates**, **isPublished** and **isPrivateFile** in the response. Accepts combination of **tags**, **customCoordinates**, **isPrivateFile**, **embeddedMetadata**, **customMetadata**, and **metadata**.",
      optional: true,
    },
    extensions: {
      type: "string[]",
      label: "Extensions",
      description: "An array of stringified object extensions to be applied to the image. For reference about extensions [read here](https://docs.imagekit.io/extensions/overview).",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "The final status of pending extensions will be sent to this URL. To learn more about how ImageKit uses webhooks, [refer here](https://docs.imagekit.io/extensions/overview#webhooks).",
      optional: true,
    },
    overwriteFile: {
      type: "boolean",
      label: "Overwrite File",
      description: "Default is **true**. If **overwriteFile** is set to **false** and **useUniqueFileName** is also **false**, and a file already exists at the exact location, upload API will return an error immediately.",
      optional: true,
    },
    overwriteAITags: {
      type: "boolean",
      label: "Overwrite AI Tags",
      description: "Default is **true**. If the request does not have **tags**, **overwriteTags** is set to **true** and a file already exists at the exact location, exiting **tags** will be removed. In case the request body has **tags**, setting **overwriteTags** to **false** has no effect and request's **tags** are set on the asset.",
      optional: true,
    },
    overwriteCustomMetadata: {
      type: "boolean",
      label: "Overwrite Custom Metadata",
      description: "Default is **true**. If the request does not have **customMetadata**, **overwriteCustomMetadata** is set to **true** and a file already exists at the exact location, exiting **customMetadata** will be removed. In case the request body has **customMetadata**, setting **overwriteCustomMetadata** to **false** has no effect and request's **customMetadata** is set on the asset.",
      optional: true,
    },
    customMetadata: {
      type: "object",
      label: "customMetadata",
      description: "A JSON key-value data to be associated with the asset. Checkout **overwriteCustomMetadata** parameter to understand default behaviour. Before setting any custom metadata on an asset you have to create the field using [custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api).",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      imagekitIo,
      file,
      customMetadata,
      extensions,
      ...appendData
    } = this;

    const data = await getFileFormData(file);

    if (extensions) {
      const processedExtensions = Array.isArray(extensions)
        ? extensions.map((item) => typeof item === "object"
          ? JSON.stringify(item)
          : item)
        : extensions;

      data.append("extensions", JSON.stringify(processedExtensions));
    }

    for (const [
      label,
      value,
    ] of Object.entries(appendData)) {
      data.append(label, value.toString());
    }

    if (customMetadata) {
      data.append("customMetadata", fieldToString(customMetadata));
    }

    const response = await imagekitIo.uploadImage({
      $,
      headers: data.getHeaders(),
      data,
    });

    $.export("$summary", `The file with Id: ${response.fileId} was successfully uploaded!`);
    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
ImageKit.io	`imagekitIo`	`app`	This component uses the ImageKit.io app.
File Path or URL	`file`	`string`	The file to upload. Provide a file URL or a path to a file in the `/tmp` directory. This can be a binary file or a base64-encoded string.
File Name	`fileName`	`string`	The name with which the file has to be uploaded. The file name can contain: - Alphanumeric Characters: a-z , A-Z , 0-9 (including unicode letters, marks, and numerals in other languages) - Special Characters: . and - Any other character including space will be replaced by _
Use Unique Filename	`useUniqueFileName`	`boolean`	Whether to use a unique filename for this file or not. If set true, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. If set false, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. Default Value is True
Tags	`tags`	`string[]`	Set the tags while uploading the file. `%` is not allowed. If this field is not specified and the file is overwritten then the tags will be removed.
Folder	`folder`	`string`	The folder path (e.g. /images/folder/) in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. The nesting of folders can be at most 50 levels deep. The folder name can contain: - Alphanumeric Characters: a-z , A-Z , 0-9 (including unicode letters, marks, and numerals in other languages). - Special Characters: /, _ and -. - Using multiple / creates a nested folder.
Is Private File	`isPrivateFile`	`boolean`	Whether to mark the file as private or not. This is only relevant for image type files.
Is Published	`isPublished`	`boolean`	Whether to upload file as published or not. If set false, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. - The option to upload in draft state is only available in custom enterprise pricing plans.
Custom Coordinates	`customCoordinates`	`string`	Define an important area in the image. This is only relevant for image type files. The the format x,y,width,height. For example - 10,10,100,100.
Response Fields	`responseFields`	`string[]`	A list of the fields that you want the API to return in the response. For example, set the value of this field to tags, customCoordinates, isPrivateFile to get the value of tags, customCoordinates, isPublished and isPrivateFile in the response. Accepts combination of tags, customCoordinates, isPrivateFile, embeddedMetadata, customMetadata, and metadata.
Extensions	`extensions`	`string[]`	An array of stringified object extensions to be applied to the image. For reference about extensions read here
Webhook URL	`webhookUrl`	`string`	The final status of pending extensions will be sent to this URL. To learn more about how ImageKit uses webhooks, refer here
Overwrite File	`overwriteFile`	`boolean`	Default is true. If overwriteFile is set to false and useUniqueFileName is also false, and a file already exists at the exact location, upload API will return an error immediately.
Overwrite AI Tags	`overwriteAITags`	`boolean`	Default is true. If the request does not have tags, overwriteTags is set to true and a file already exists at the exact location, exiting tags will be removed. In case the request body has tags, setting overwriteTags to false has no effect and request's tags are set on the asset.
Overwrite Custom Metadata	`overwriteCustomMetadata`	`boolean`	Default is true. If the request does not have customMetadata, overwriteCustomMetadata is set to true and a file already exists at the exact location, exiting customMetadata will be removed. In case the request body has customMetadata, setting overwriteCustomMetadata to false has no effect and request's customMetadata is set on the asset.
customMetadata	`customMetadata`	`object`	A JSON key-value data to be associated with the asset. Checkout overwriteCustomMetadata parameter to understand default behaviour. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API
syncDir	`syncDir`	`dir`

Action Authentication#

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

To retrieve your Private Key,