Contentful Connector

​

Overview

• Publishing to any content type
• Rich Text content formatting
• Asset management and linking
• Entry references for taxonomies
• Scheduled publishing

​

Prerequisites

1. Contentful space with a content type for articles
2. Content Management API token with write permissions
3. Space ID from your Contentful dashboard
4. Environment ID (usually master)

​

Setup Guide

​

Step 1: Get Your Space ID

1. Go to your Contentful dashboard
2. Navigate to Settings → General settings
3. Copy the Space ID

​

Step 2: Create a Content Management Token

1. Go to Settings → API keys
2. Click Content management tokens tab
3. Click Generate personal token
4. Give it a descriptive name (e.g., “Skayle Integration”)
5. Copy the generated token

​

Step 3: Create Your Content Type

​

Step 4: Configure in Skayle

1. Go to Settings → Connectors in Skayle
2. Select Contentful as your connector type
3. Enter your configuration:

interface ContentfulConnectorConfig {
  type: "contentful";
  spaceId: string;           // Your Contentful space ID
  accessToken: string;       // Content Management API token
  environment: string;       // Environment ID (default: "master")
  contentTypeId: string;     // Content type ID for articles

  fieldMapping: {
    title: string;           // Field ID for title
    slug: string;            // Field ID for slug
    excerpt: string;         // Field ID for excerpt
    body: string;            // Field ID for body (Rich Text)
    featuredImage?: string;  // Field ID for featured image
    publishDate?: string;    // Field ID for publish date
  };

  taxonomyMapping: {
    category: string;        // Field ID for categories
    tag: string;             // Field ID for tags
    author: string;          // Field ID for author
  };

  taxonomyContentTypes: {
    category: string;        // Content type ID for categories
    tag: string;             // Content type ID for tags
    author: string;          // Content type ID for authors
  };
}

4. Click Test Connection to verify

​

Content Formatting

​

Rich Text Structure

{
  "nodeType": "document",
  "data": {},
  "content": [
    {
      "nodeType": "paragraph",
      "data": {},
      "content": [
        {
          "nodeType": "text",
          "value": "Hello world",
          "marks": [],
          "data": {}
        }
      ]
    }
  ]
}

​

Supported Node Types

​

Text Marks

​

Asset Management

​

Uploading Images

1. Upload the asset file
2. Create an asset entry
3. Process the asset
4. Publish the asset
5. Reference in content

​

Asset Structure

{
  "sys": {
    "type": "Link",
    "linkType": "Asset",
    "id": "asset-id"
  }
}

​

Taxonomy Mapping

​

Entry References

{
  "sys": {
    "type": "Link",
    "linkType": "Entry",
    "id": "author-entry-id"
  }
}

[
  {
    "sys": {
      "type": "Link",
      "linkType": "Entry",
      "id": "category-entry-id-1"
    }
  },
  {
    "sys": {
      "type": "Link",
      "linkType": "Entry",
      "id": "category-entry-id-2"
    }
  }
]

​

Taxonomy Content Types

​

Publishing Workflow

​

Entry States

1. Draft: Entry exists but isn’t published
2. Changed: Published entry with unpublished changes
3. Published: Entry is live
4. Archived: Entry is archived

​

Publishing Process

Create Entry (Draft) → Publish Entry → Live

• Create as draft only
• Auto-publish immediately
• Schedule for future publication

​

Localization

{
  locale: "en-US"  // Default locale for content
}

​

Troubleshooting

​

Connection Issues

​

Content Issues

​

API Rate Limits

​

Best Practices

1. Use environments: Test in a non-master environment first
2. Validate content types: Ensure field IDs match exactly
3. Sync taxonomies first: Create category/tag entries before articles
4. Monitor webhooks: Set up webhooks for sync notifications
5. Use content models: Design your content model before integration

​

Next Steps