API Documentation

API Documentation

Introduction

Welcome to the QuickBuzz API documentation. This guide will help you integrate your applications with QuickBuzz's powerful WordPress content generation platform.

To use the API, you'll need an API key. Sign in or create an account to get your API key.

Authentication

All API requests require authentication using your API key. You should include your API key as a query parameter in all requests.

https://quickbuzz.io/api/v1/zapier/articles/?api_key=YOUR_API_KEY&space_id=YOUR_SPACE_ID&email=YOUR_EMAIL

Replace YOUR_API_KEY with your actual API key, YOUR_SPACE_ID with your space ID, and YOUR_EMAIL with your account email.

API Endpoints

Authentication Test

Use this endpoint to verify your API key is working correctly.

GET /api/v1/zapier/auth/me/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Example Response:
{
  "message": "Connected!",
  "email": "[email protected]",
  "space_name": "My Organization"
}
Get Articles

Retrieve a list of your published articles.

GET /api/v1/zapier/articles/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Request Body:
Parameter Type Description
wordpress_site_id string Optional: Filter articles by WordPress site ID
Example Response:
[
  {
    "id": "123",
    "title": "10 Ways to Improve Your Website SEO",
    "site_url": "https://myblog.com",
    "site_name": "My WordPress Blog",
    "article_link": "https://myblog.com/10-ways-to-improve-seo",
    "published_timestamp": "1623766245.0"
  },
  {
    "id": "124",
    "title": "The Ultimate Guide to Content Marketing",
    "site_url": "https://mycompany.com",
    "site_name": "Company Website",
    "article_link": "https://mycompany.com/content-marketing-guide",
    "published_timestamp": "1623852922.0"
  }
]
Get WordPress Websites

Retrieve a list of your connected WordPress websites.

GET /api/v1/zapier/websites/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Example Response:
[
  {
    "id": "123",
    "site_url": "https://myblog.com",
    "site_name": "My WordPress Blog"
  },
  {
    "id": "124",
    "site_url": "https://mycompany.com",
    "site_name": "Company Website"
  }
]
Generate Article Content

Generate content for a new article using AI.

POST /api/v1/wordpress/article/generate-content/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Request Body:
Parameter Type Description
keyword string The main keyword for the article
title string The title of the article (optional)
tone string The tone of the article (e.g., "professional", "casual", "friendly")
Example Response:
{
  "success": true,
  "article_id": 123,
  "article_uuid": "12345678-1234-5678-1234-567812345678",
  "title": "10 Ways to Improve Your Website SEO",
  "content": "This is the generated content of the article...",
  "status": "draft"
}

Webhooks

Webhooks allow you to receive real-time notifications when certain events occur in your QuickBuzz account. Currently, we support webhooks for article creation events.

Subscribe to Article Creation Webhook

Use this endpoint to subscribe to notifications when new articles are published.

POST /api/v1/zapier/new-article-create/subscribe/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Request Body:
Parameter Type Description
hookUrl string The URL where webhook notifications should be sent
Example Response:
{
  "success": true,
  "message": "Successfully subscribed to article.published events",
  "subscription_id": "12345678-1234-5678-1234-567812345678",
  "hookUrl": "https://hooks.zapier.com/hooks/catch/123456/abcdef/"
}
Unsubscribe from Article Creation Webhook

Use this endpoint to unsubscribe from article creation notifications.

DELETE /api/v1/zapier/new-article-create/unsubscribe/
Query Parameters:
Parameter Type Description
api_key string Your API key
space_id string Your space ID
email string Your account email
Request Body:
Parameter Type Description
hookUrl string The URL to unsubscribe
Example Response:
{
  "success": true,
  "message": "Successfully unsubscribed from article.published events"
}
Webhook Payload Example

When an article is published, a webhook notification will be sent to your target URL with the following payload:

{
    "id": "123",
    "title": "10 Ways to Improve Your Website SEO",
    "site_url": "https://myblog.com",
    "site_name": "My WordPress Blog",
    "article_link": "https://myblog.com/10-ways-to-improve-seo",
    "published_timestamp": "1623766245.0"
}

The webhook request will include the following headers:

Header Description
Content-Type application/json
User-Agent QuickBuzz-Webhook/1.0
X-QuickBuzz-Event article.published
X-QuickBuzz-Delivery A unique identifier for the webhook delivery

Zapier Integration

QuickBuzz integrates seamlessly with Zapier, allowing you to connect your WordPress content with thousands of other apps.

Zapier

Zapier Integration

Connect QuickBuzz with 5,000+ apps

Use Zapier to automate your content workflow by connecting QuickBuzz with your favorite apps like WordPress, Google Drive, Dropbox, Slack, and more.

Custom Integration

Build your own integration

Need a custom integration? Use our API to build your own integration with QuickBuzz for your WordPress content workflow.