Skip to content
  • Documentation >
  • Apps >
  • Website Building >
  • Ghost

Ghost

The Ghost modules allow you to create, update, list, and/or delete authors, posts, pages, and tags in your Ghost account.

Prerequisites

  • A Ghost account

  • A site in Ghost

In order to use Ghost with Ibexa Connect, it is necessary to have a Ghost account. If you do not have one, you can create a Ghost account at //ghost.org/.

Connecting Ghost to Ibexa Connect

To connect your Ghost account to Ibexa Connect, you need to obtain your API URL, Admin API Key, and Ibexa Connect ID.

1. Log in to your Ghost Account.

2. From the left menu, click Integrations and select your Ibexa Connect integration which you want to use for establishing a connection to Ibexa Connect.

61f26e529739a.gif

To add integration in your Ghost site, see Adding Ibexa Connect Integrations in Ghost.

3. Copy the Admin API Key, and API URL to your clipboard.

61f26e5542962.png

4. On the same page, in the Webhooks section, copy the Ibexa Connect ID to your clipboard.

61f26e56419cb.png

5. Go to Ibexa Connect and open the Ghost module's Create a connection dialog.

61f26e57382b2.gif

6. In the Connection name field, enter a name for the connection.

7. In the API URL and Admin API Key fields, enter the values copied in the step 3 in the respective fields.

8. In the Ibexa Connect ID field, enter the values copied in step 4 and click Continue.

61f26e595f8e7.png

The connection has been established.

Posts

Watch Posts

Triggers when a post is created, updated, or deleted.

Webhook name

Enter a name for the webhook.

Event

Select the event you want to watch:

  • Post created

  • Post updated

  • Post deleted

  • Post published

  • Published post updated

  • Post unpublished

  • Tag added to post

  • Tag removed from post

Create a Post

Creates a post.

Title

Enter a title for the post.

Status

Select the status of the post:

  • Draft

  • Scheduled

  • Published

Slug

Enter the slug details of the website where the post is getting published.

Type of Content

Select the content type for the post:

  • HTML

  • Mobiledoc

HTML

Enter the content of the post in HTML format.

Mobiledoc

Enter the content of the post in HTML format.

Custom Excerpt

Enter the length of the words for the post.

Feature Image

Enter the link to the image that appears along with the post.

Tags

Add keywords for the post that can be used to filter the post when searching.

Authors

Add authors for the post. You can add multiple authors.

Featured

Select Yes if this is a featured post:

  • Yes

  • No

  • Not defined

Canonical URL

Enter the post website URL that represents almost the original website URL.

Meta Title

Enter the title URL of the post that appears in the search engine results.

Meta Description

Enter the description that appears in the search engine results below the URL link.

Facebook Title

Enter the Facebook title of the post.

Facebook Description

Enter the details of the post to mention on Facebook.

Facebook Image

Enter the image link to upload on Facebook.

Twitter Title

Enter the Twitter title of the post.

Twitter Description

Enter the details of the post to mention on Twitter.

Twitter Image

Enter the link for the Twitter profile image.

Search Posts

Lists all posts or searches posts by criteria.
Criteria Select the criteria to filter the posts you want to search for. For example, Member ID, created date, name, email, and so on.
Limit The maximum number of posts Ibexa Connect should return during one scenario execution cycle.

Update a Post

Updates a Post.

Post ID

Select the Post ID you want to update.

Title

Enter a title for the post.

Status

Select the status of the post:

  • Draft

  • Scheduled

  • Published

Slug

Enter the slug details of the website where the post is getting published.

Type of Content

Select the content type for the post:

  • HTML

  • Mobiledoc

HTML

Enter the content of the post in HTML format.

Mobiledoc

Enter the content of the post in HTML format.

Custom Excerpt

Enter the length of the words for the post.

Feature Image

Enter the link to the image that appears along with the post.

Tags

Add keywords for the post that can be used to filter the post when searching.

Authors

Add authors for the post. You can add multiple authors.

Featured

Select Yes if this is a featured post:

  • Yes

  • No

  • Not defined

Canonical URL

Enter the post website URL that represents almost the original website URL.

Meta Title

Enter the title URL of the post that appears in the search engine results.

Meta Description

Enter the description that appears in the search engine results below the URL link.

Facebook Title

Enter the Facebook title of the post.

Facebook Description

Enter the details of the post to mention on Facebook.

Facebook Image

Enter the image link to upload on Facebook.

Twitter Title

Enter the Twitter title of the post.

Twitter Description

Enter the details of the post to mention on Twitter.

Twitter Image

Enter the image link to upload on Twitter.

Delete a Post

Deletes a post.
Post ID Select the Post ID you want to delete.

Pages

Watch Pages

Triggers when a page is created, updated, or deleted.

Webhook name

Enter a name for the webhook.

Event

Select the event you want to watch:

  • Page created

  • Page updated

  • Page deleted

  • Page published

  • Published page updated

  • Page unpublished

  • Tag added to page

  • Tag removed from page

Tags

Watch Tags

Triggers when a tag is created, updated, or deleted.

Webhook name

Enter a name for the webhook.

Event

Select the event you want to watch:

  • Tag created

  • Tag updated

  • Tag deleted

Authors

Search Authors

Lists all members or searches members by criteria.
Criteria Select the criteria for the members you want to search for. For example, Member ID, created date, name, email, and so on.
Limit The maximum number of authors Ibexa Connect should return during one scenario execution cycle.

Member

Watch Members

Triggers when a member is created, updated, or deleted.

Webhook Name

Enter a name for the webhook.

Event

Select the event you want to watch:

  • Member added

  • Member updated

  • Member deleted

Create a Member

Creates a member.

Name

Enter the name of the member.

Email

Enter the email address of the member.

Note

Enter any additional details of the member.

Subscribed to newsletter

Select Yes if the member is subscribed for the newsletter:

  • Yes

  • No

  • Not defined

Search Members

Lists all members or searches members by criteria.
Criteria Select the criteria for the members you want to search for. For example, Member ID, created date, name, email, and so on.
Limit The maximum number of members Ibexa Connect should return during one scenario execution cycle.

Delete a Member

Deletes a member.
Member ID Select the Member ID you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to {{your_host}}/ghost/api. E.g. /v3/admin/site.

For the list of available endpoints, refer to the Ghost API Documentation.

Method

Select the HTTP method you want to use:

GETto retrieve information for an entry.

POSTto create a new entry.

PUTto update/replace an existing entry.

PATCHto make a partial entry update.

DELETEto delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example - List Posts

Following API call returns all posts:

61f26e5a528ba.png

Matches of the search can be found in the module's Output under Bundle > Body > *posts.*In our example, 15 posts were returned:

61f26e5b3547a.png

Adding Ibexa Connect Integrations in Ghost

To add integrations in Ghost:

1. Log in to your Ghost account.

2. From the left menu, click Integration --> Add custom integration. Enter a name for the integration and click Create.

61f26e5c20099.gif

The integration is added successfully.