Ghost
Create, list, and update posts on your Ghost publication.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("ghostcms", "create_post", {
"title": "<title>",
"status": "draft",
"html": "<content (html)>",
"author": "<author>"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Ghost answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "ghostcms-create-post",
name: "Ghost: Create Post",
description: "Calls Ghost when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("ghostcms", {
"action": "create_post",
"title": "<title>",
"status": "draft",
"html": "<content (html)>",
"author": "<author>"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/ghostcms/create_post" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"title":"<title>","status":"draft","html":"<content (html)>","author":"<author>"}}'Actions
create_postin catalog
Create Post. Create a new post
| Input | Type | Description |
|---|---|---|
titlerequired | text | Title |
slugoptional | text | Slug |
statusrequired | one of "draft" | "published" | "scheduled" | Status |
publishedAtoptional | date-time (ISO) | Published At |
htmlrequired | long text | Content (HTML) |
customExcerptoptional | text | Custom Excerpt |
authorrequired | id (picked from your account) | Author |
featuredoptional | boolean | Featured |
tagsoptional | ids (picked from your account) | Tags |
create_member
Create Member. Create a new member
| Input | Type | Description |
|---|---|---|
emailrequired | text | |
nameoptional | text | Full Name |
noteoptional | text | Note |
newslettersoptional | ids (picked from your account) | Newsletters |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
find_member
Find Member. Find a member by email
| Input | Type | Description |
|---|---|---|
emailrequired | text |
find_user
Find User. Find a staff user by email
| Input | Type | Description |
|---|---|---|
emailrequired | text |
update_member
Update Member. Update a member
| Input | Type | Description |
|---|---|---|
memberrequired | id (picked from your account) | Member |
emailoptional | text | |
nameoptional | text | Full Name |
noteoptional | text | Note |
newslettersoptional | ids (picked from your account) | Newsletters |
Details
- Id
ghostcms- Category
- Content
- Tags
- cms, blog, publishing, newsletter
- Package
@activepieces/piece-ghostcms@0.1.4- Tier
- Community