Return HTTP Response with HTTP / Webhook API on New Author from Ghost.org (Content API) API

Pipedream makes it easy to connect APIs for HTTP / Webhook, 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

Return HTTP Response with the HTTP / Webhook 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 HTTP / Webhook 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 Return HTTP Response action
1. Connect your HTTP / Webhook account
2. Configure Response Status Code
3. Optional- Configure Response Headers
4. Optional- Configure Response Body
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#

Return HTTP Response on HTTP / Webhook

Description:Use with an HTTP trigger that uses "Return a custom response from your workflow" as its `HTTP Response`

Version:0.0.3

Key:http-return-http-response

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.

Action Code#

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

export default {
  key: "http-return-http-response",
  name: "Return HTTP Response",
  description:
    "Use with an HTTP trigger that uses \"Return a custom response from your workflow\" as its `HTTP Response`",
  type: "action",
  version: "0.0.3",
  props: {
    http,
    resStatusCode: {
      type: "integer",
      label: "Response Status Code",
      description:
        "The [status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) to return in the HTTP response.",
      default: 200,
      min: 100,
      max: 599,
    },
    resHeaders: {
      type: "object",
      label: "Response Headers",
      description: "The headers to return in the HTTP response.",
      optional: true,
    },
    resBody: {
      type: "any",
      label: "Response Body",
      description: "The body to return in the HTTP response.",
      optional: true,
      default: "{ \"success\": true }",
    },
  },
  async run({ $ }) {
    const status = this.resStatusCode;
    await $.respond({
      status,
      headers: this.resHeaders,
      body: this.resBody,
    });
    $.export("$summary", `Responded successfully with status ${status}`);
  },
};

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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Response Status Code	`resStatusCode`	`integer`	The status code to return in the HTTP response.
Response Headers	`resHeaders`	`object`	The headers to return in the HTTP response.
Response Body	`resBody`	`any`	The body to return in the HTTP response.

Action Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

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