Introduction

Welcome to the Postixly Social Publisher API documentation.

Base URL

All endpoints are relative to:

Production: https://api.postixly.com Local Development: http://localhost:3001

What this API does

The API creates and manages social posts, API keys, and webhooks.
Publishing is asynchronous: requests are queued in Redis and processed by workers.

High-level flow

1. Your app sends a request to POST /posts or POST /posts/schedule.
2. The API validates ownership, plan limits, and targets.
3. A job is enqueued in BullMQ (publish-post).
4. Worker instances publish to each target platform and update statuses.
5. Webhooks are dispatched (post.published, post.failed, post.partial).

Platform support in current worker

• Fully implemented adapters: instagram, tiktok, youtube
• Mock adapters: twitter, linkedin, facebook

Important limits and behavior

• Request body limit: 1 MB
• Job retries: 3 attempts with exponential backoff (5s, 10s, 20s)
• Immediate publish waits up to 30s for final status before response