Docs

Changelog

Stay up to date with the latest changes, improvements, and new features in the Zyhap Developer API.

v2.1.0

Marketing Campaigns

October 10, 2026

New

  • Campaigns API: list and read campaigns, their results and attribution, create draft campaigns and tracked links at /api/v1/public/marketing/campaigns.
  • Scopes: marketing:read:campaigns, marketing:write:campaigns, marketing:read:campaign_metrics.
  • Webhook events: marketing.campaign.* (created, approved, launched, paused, completed, budget_threshold, kpi_reached) and marketing.promo.redeemed.
v2.0.0

Social is now Marketing

October 6, 2026

Breaking

  • Base path: /api/v1/public/social is now /api/v1/public/marketing. The old path no longer answers.
  • Scopes: social:read:content and the rest are now marketing:read:content and so on. Keys you already hold were moved to the new names for you.
  • Webhook events: social.post.published and the rest are now marketing.post.published and so on. Existing subscriptions were moved to the new names; update any code that compares the event name.
  • Module key: a key's module is marketing, not social.

Unchanged

  • Unprefixed scopes such as read:content and the older event names such as post.published still work, exactly as before.
  • Request and response bodies, the X-Workspace-ID header, and every other module's endpoints are unchanged.
v1.2.0

CRM is live

September 30, 2026

New

  • CRM API: leads, customers, deals, activities and campaigns at /api/v1/public/crm. Creating a lead that already exists returns it with "duplicate": true.
  • CRM webhook events: crm.lead.*, crm.customer.*, crm.deal.* and crm.activity.*.
  • Idempotency-Key: send it on a POST and a retry within 24 hours returns the first answer instead of doing the work twice.

Changed

  • Keys are bounded by their owner: a CRM request needs the key's scope and the owner's own CRM permission in that branch, today. Removing the owner's permission stops the key at once.
  • Rate limits are shared across all our servers, so a key's budget is the same whichever server answers.
v1.1.0

One API for every module

September 24, 2026

The Developer API now covers the whole Business OS, not just Social. Nothing you have built stops working.

What changed

  • Module paths: endpoints live at /api/v1/public/{module}/..., for example /api/v1/public/social/posts. GET /api/v1/public lists what is live.
  • Webhooks for every module: subscriptions moved to /api/v1/public/webhooks and belong to a branch. Choose it with X-Branch-ID.
  • Namespaced events: post.published is now social.post.published, and so on.
  • Namespaced scopes: read:content is now social:read:content; webhook scopes are platform:*:webhooks.
  • Signed by default: every new webhook gets a signing secret, returned once.

Still works

  • The /v1/public/social/... address, including /social/webhooks.
  • Keys holding the old scope names, and subscriptions using the old event names (they keep receiving the old names).
v1.0.0

Initial Release

July 19, 2025

🎉 The first stable release of the Zyhap Developer API is now available!

✨ New Features

  • Posts Management: Schedule, update, and delete social media posts
  • Connected Accounts: Retrieve information about connected social media accounts
  • Pages & Destinations: Get available posting destinations for each platform
  • Draft Management: Create, update, and manage draft posts
  • Webhooks System: Real-time notifications for post events and account changes
  • Multi-platform Support: Facebook, Instagram, Twitter/X, LinkedIn, and TikTok

🔐 Security

  • API key authentication with workspace-level isolation
  • Rate limiting: 60 requests/minute, 1000 requests/hour
  • HTTPS-only endpoints for secure communication
  • Webhook signature verification for secure event delivery

📊 API Endpoints

  • POST /posts - Schedule posts
  • GET /posts - Retrieve posts with filtering
  • PATCH /posts/:id - Update scheduled posts
  • DELETE /posts/:id - Delete posts
  • GET /accounts - Get connected accounts
  • GET /pages - Get posting destinations
  • POST /drafts - Create drafts
  • GET /drafts - Retrieve drafts
  • POST /webhooks - Register webhooks
  • GET /webhooks - Manage webhooks

📖 Documentation

  • Complete API reference with examples
  • Getting started guide with step-by-step instructions
  • Code examples in Node.js, Python, PHP, and C#
  • Webhook implementation examples
  • Troubleshooting and FAQ sections
Coming Soon

Planned Features

Here's what we're working on for future releases:

🚀 v1.1.0 (Q4 2025)

  • Media Upload API: Direct media upload to Zyhap storage
  • Bulk Operations: Batch endpoints for scheduling multiple posts
  • Advanced Filtering: More query options for posts and drafts
  • Analytics Endpoints: Basic post performance metrics

🛠️ v1.2.0 (Q1 2026)

  • Official SDKs: Node.js, Python, PHP, and C# libraries
  • GraphQL API: Alternative GraphQL endpoint for complex queries
  • Team Management: API access control and team permissions
  • Custom Fields: Add metadata to posts and drafts

🔮 Future Versions

  • AI Content Generation: API endpoints for AI-assisted content creation
  • Advanced Analytics: Detailed engagement and performance metrics
  • Content Templates: Reusable post templates via API
  • Real-time Collaboration: Live editing and approval workflows

Versioning & Breaking Changes

📋 Our Commitment

  • We follow semantic versioning (MAJOR.MINOR.PATCH)
  • Breaking changes will only occur in major version releases
  • Deprecated features will be supported for at least 6 months
  • All breaking changes will be documented with migration guides

🔔 Stay Updated

We recommend subscribing to our changelog updates:

Feedback & Feature Requests

We'd love to hear from you! Your feedback helps us prioritize new features and improvements.