Documentation
Documentation
The dashboard guide, the public API reference, the PHP SDK and the Laravel package.
Guide Version 1.0
-
Getting started
Quiet Social publishes for your brands on Facebook, Instagram, LinkedIn, Threads, Pinterest, Mastodon and Bluesky, right away or on the…
-
Workspaces and brands
The workspace is your team account. It contains your brands, your network connections, your members and your history. Its address is part…
-
Connecting your networks
Authorise Quiet Social on Meta, LinkedIn, Threads, Pinterest, Mastodon or Bluesky, then attach the accounts found to a brand: each attached…
-
Destinations
A destination is a specific account on which a brand publishes: a Facebook Page, an Instagram professional account, a LinkedIn Page, a…
-
Publications
A publication carries a shared text, an optional link and optional images, and goes out to one or more destinations of a brand. Each…
-
Media
Each brand has its own image library. An image is uploaded there once, then attached to as many publications as you like.
-
Calendar
The Calendar shows your publications month by month or week by week, from Monday to Sunday, each on the day it goes out or went out; it…
-
Approval
A publication created with Submit for approval does not leave until someone has approved it. Two ways: a team member in the dashboard, or…
-
Team and invitations
A workspace is shared. Each member has a role in it, which decides what they can do.
-
History
The History keeps track of what has been done in the workspace, and by whom. All members can read it.
-
Quotas and usage
Every month and for each brand, Quiet Social measures the publications created and the successful deliveries to the networks. A delivery is…
-
Revoking a connection
Revoking a connection cuts Quiet Social's access to the network account. It is reserved for administrators and the owner.
-
Deleting your account
Deleting your account cuts off your access at once and erases, seven days later, the account and the workspaces you own. The request cannot…
-
API keys and webhooks
An API key lets an application — your website, your shop — publish through the API on behalf of the workspace; a webhook tells that…
-
Own applications
If a network blocks the Quiet Social application, your connections can go through an application you created yourself on that network. It…
-
Templates
A template keeps a text, a link, hashtags and, for a brand, destinations and images, so that the next publication can start from them. A…
API Version 1.0
-
Introduction
The Quiet Social REST API lets your application publish to a brand's networks without going through the dashboard: an article going live, a…
-
Authentication
The API authenticates an application, not a person. Each client application receives a public identifier and a secret, which it presents…
-
Scopes
An API client can only call the routes whose scope it holds. Each route declares the one it requires; a client that lacks it receives 403.
-
Idempotency
The central risk of a publishing API is publishing twice. An HTTP client that loses the response to a POST will retry, and without a…
-
Brands and destinations
A brand is what you publish for: a company, a client, a product. A destination is a specific account on which a brand publishes: a Facebook…
-
Publications
A publication carries shared content and one target per chosen destination. Each target has its own status, its own text and its own…
-
Media
An image is uploaded to a brand's library, then attached to a publication by its med_… identifier. The upload takes a single request.
-
Webhooks
A webhook notifies your application when a publication changes state, without it having to poll the API. Quiet Social sends a signed POST…
-
Errors
For each refusal from the API, this page answers a single question: should you retry?
-
Limits and conventions
What the API limits, and the conventions it follows on all its routes: rate, pagination, identifiers, dates and quotas.
-
MCP server
Quiet Social exposes an MCP (Model Context Protocol) server: a compatible conversational assistant can read your brands, destinations and…
PHP SDK Version 0.1
-
Introduction
The PHP SDK quiet-social/php-social publishes to Facebook, Instagram, LinkedIn, Threads and Pinterest from any PHP application. It talks to…
-
Installation and authentication
The SDK installs through Composer, without any dependency, and authenticates with an API key created in the Quiet Social panel: a qsc_……
-
Publishing
A Post describes what to publish, once for every network, and publications()->create() publishes it to the given targets. This page…
-
Images
An image goes with a post, or with one network through for(), along with its alternative text. The SDK uploads it before creating the…
-
Targeting
The to: parameter of publications()->create() says where to publish: network names, destination ids, or both. The SDK resolves them…
-
Errors
Every refusal of the API becomes a named exception, which answers the only question asked after a failure: can the same call succeed if…
-
Webhooks
The API notifies your application when a publication changes state, with a signed POST request. The SDK declares endpoints and verifies the…
-
Testing and transports
The SDK sends every request through a transport: CurlTransport by default, FakeTransport in your tests, or a class of your own. This page…
Laravel package Version 0.1
-
Introduction
The quiet-social/laravel-social package publishes your Eloquent models to Facebook, Instagram, LinkedIn, Threads and Pinterest. Describe…
-
Installation and configuration
The package is installed with Composer along with the PHP SDK, creates its table through a migration, and is configured through…
-
Adopting the package on an existing database
Read this before adding PublishesToSocial to a model that already has rows: without the social:baseline command, the first save of each…
-
Describing a post
A model describes its post through the PublishesToSocial trait and PHP attributes, through public methods named by convention, or both…
-
Methods by convention and priorities
A public method of the model, named by convention and without required parameters, does the same job as an attribute parameter. When…
-
Automatic synchronisation
Each save or deletion of a model queues a job that aligns the remote post with the model: it sends it, replaces it while it has not left…
-
Covers
The cover of a post is its image: an SDK Image, a URL, an absolute path below an allowed directory, or a path on a disk. The package…
-
Publishing, cancelling and previewing by hand
The PublishesToSocial trait gives the model three methods: publishToSocial() forces the synchronisation, cancelSocialPublication()…
-
Laravel events
The package raises eight Laravel events, all in QuietSocial\Social\Events: three come from the synchronisation of your models, five from…
-
Webhooks
With a signing secret, the package registers a route that receives Quiet Social notifications, verifies each one, keeps the status of…
-
Testing
SocialPublisher::fake() replaces every call to the API with a fake that records each post: your tests check what would have been published…
-
The manual builder
For a publication written by hand rather than described by a model, SocialPublisher::post() opens a builder that reads like a sentence…
A question this documentation does not answer?
Write to us: an answer missing here is a page to complete.