← Ghost.org (Admin API) + Discord Webhook integrations

Send Message (Advanced) with Discord Webhook API on New Member Created (Instant) from Ghost.org (Admin API) API

Pipedream makes it easy to connect APIs for Discord Webhook, Ghost.org (Admin API) and 900+ other apps remarkably fast.

Trigger workflow on
New Member Created (Instant) from the Ghost.org (Admin API) API
Next, do this
Send Message (Advanced) with the Discord Webhook API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a Ghost.org (Admin API) trigger and Discord Webhook action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Member Created (Instant) trigger
    1. Connect your Ghost.org (Admin API) account
  3. Configure the Send Message (Advanced) action
    1. Connect your Discord Webhook account
    2. Optional- Configure Message
    3. Optional- Configure Thread ID
    4. Optional- Configure Username
    5. Optional- Configure Avatar URL
    6. Optional- Configure Include link to workflow
    7. Optional- Configure Embeds
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emit new event for each new member added to a site.
Version:0.0.8
Key:ghost_org_admin_api-member-created

Trigger Code

import common from "../common-webhook.mjs";

export default {
  ...common,
  type: "source",
  key: "ghost_org_admin_api-member-created",
  name: "New Member Created (Instant)",
  description: "Emit new event for each new member added to a site.",
  version: "0.0.8",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "member.added";
    },
    generateMeta(body) {
      return ({
        id: body.member.current.id,
        summary: body.member.current.name,
        ts: Date.now(),
      });
    },
  },
};

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.
LabelPropTypeDescription
Ghost.org (Admin API)ghostAdminApiappThis component uses the Ghost.org (Admin API) app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis 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.

Trigger Authentication

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

Admin API keys are created by Custom Integration under the Integrations screen in Ghost Admin.
Admin API is your full domain (https://yourdomain.com) and is also listed in your Custom Integration UI

About Ghost.org (Admin API)

Open source publishing platform

Action

Description:Send a simple or structured message (using embeds) to a Discord channel
Version:0.3.1
Key:discord_webhook-send-message-advanced

Discord Webhook Overview

With Discord's Webhook API, you can create applications that send messages to
Discord channels automatically. For example, you could create a bot that sends
a message to a channel every time a new blog post is published, or a message to
a channel when someone joins your Discord server.

Here are some ideas for what you could build using the Discord Webhook API:

  • A bot that sends a message to a channel when a new blog post is published
  • A bot that sends a message to a channel when someone joins your Discord
    server
  • A bot that sends a message to a channel when a new product is added to your
    online store

Action Code

import common from "../send-message-common.mjs";

export default {
  ...common,
  key: "discord_webhook-send-message-advanced",
  name: "Send Message (Advanced)",
  description: "Send a simple or structured message (using embeds) to a Discord channel",
  version: "0.3.1",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discordWebhook,
        "message",
      ],
      optional: true,
    },
    embeds: {
      propDefinition: [
        common.props.discordWebhook,
        "embeds",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      embeds,
    } = this;

    if (!message && !embeds) {
      throw new Error("This action requires at least 1 message OR embeds object. Please enter one or the other above.");
    }

    try {
      // No interesting data is returned from Discord
      await this.discordWebhook.sendMessage({
        avatarURL,
        threadID,
        username,
        embeds,
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      });
      $.export("$summary", "Message sent successfully");
    } catch (err) {
      const unsentMessage = this.getUserInputProps();
      $.export("unsent", unsentMessage);
      throw err;
    }
  },
};

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.

LabelPropTypeDescription
Discord WebhookdiscordWebhookappThis component uses the Discord Webhook app.
Messagemessagestring

Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.

Thread IDthreadIDstring

If provided, the message will be posted to this thread

Usernameusernamestring

Overrides the current username of the webhook

Avatar URLavatarURLstring

If used, it overrides the default avatar of the webhook. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.

Include link to workflowincludeSentViaPipedreamboolean

Defaults to true, includes a link to this workflow at the end of your Discord message.

Embedsembedsany

Optionally pass an array of embed objects. E.g., {{ [{"description":"Use markdown including *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"}] }}. To pass data from another step, enter a reference using double curly brackets (e.g., {{steps.mydata.$return_value}}).
Tip: Construct the embeds array in a Node.js code step, return it, and then pass the return value to this step.

Action Authentication

Discord Webhook uses OAuth authentication. When you connect your Discord Webhook account, Pipedream will open a popup window where you can sign into Discord Webhook and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Discord Webhook API.

Pipedream requests the following authorization scopes when you connect your account:

webhook.incomingemailidentify

About Discord Webhook

Use this app to send messages to a channel using Discord's incoming webhooks

More Ways to Connect Discord Webhook + Ghost.org (Admin API)

Send Message with Discord Webhook API on Member Deleted (Instant) from Ghost.org (Admin API) API
Ghost.org (Admin API) + Discord Webhook
 
Try it
Send Message with Discord Webhook API on Member Updated (Instant) from Ghost.org (Admin API) API
Ghost.org (Admin API) + Discord Webhook
 
Try it
Send Message with Discord Webhook API on New Member Created (Instant) from Ghost.org (Admin API) API
Ghost.org (Admin API) + Discord Webhook
 
Try it
Send Message with Discord Webhook API on Page Published (Instant) from Ghost.org (Admin API) API
Ghost.org (Admin API) + Discord Webhook
 
Try it
Send Message with Discord Webhook API on Post Published (Instant) from Ghost.org (Admin API) API
Ghost.org (Admin API) + Discord Webhook
 
Try it
Member Deleted (Instant) from the Ghost.org (Admin API) API

Emit new event each time a member is deleted from a site.

 
Try it
Member Updated (Instant) from the Ghost.org (Admin API) API

Emit new event each time a member is updated.

 
Try it
New Member Created (Instant) from the Ghost.org (Admin API) API

Emit new event for each new member added to a site.

 
Try it
Page Published (Instant) from the Ghost.org (Admin API) API

Emit new event for each new page published on a site.

 
Try it
Post Published (Instant) from the Ghost.org (Admin API) API

Emit new event for each new post published on a site.

 
Try it
Create Member with the Ghost.org (Admin API) API

Create a new member in Ghost. See the docs here

 
Try it
Create post with the Ghost.org (Admin API) API

Create a post. See the docs here.

 
Try it
Update Member with the Ghost.org (Admin API) API

Update a member in Ghost. See the docs here

 
Try it
Send Message with the Discord Webhook API

Send a simple message to a Discord channel

 
Try it
Send Message (Advanced) with the Discord Webhook API

Send a simple or structured message (using embeds) to a Discord channel

 
Try it