Core API

Ports are the core calling the connector. The Core API is the inverse: interfaces under Subscriby\Connector\Core\* that the application implements and binds in its container, and that a connector calls instead of importing application classes. A core refactor that keeps the contract breaks no connector, and a connector never touches a table it does not own.

Getting hold of a contractCopy Anchor Link

Ask for the interface in a constructor. The application's connector service provider binds each one to its implementation, so any class the container builds (a port, a handler, a job in your package) receives it:

use Subscriby\Connector\Core\Identities;
use Subscriby\Connector\Core\Installations;

final class ExampleInboundController
{
    public function __construct(
        private readonly Installations $installations,
        private readonly Identities $identities,
    ) {}
}

The thirty contractsCopy Anchor Link

Refs and recordsCopy Anchor Link

Two families of value object cross the boundary:

• Refs (InstallationRef, IdentityRef, SpaceRef, ResourceRef, GrantRef, ProjectRef, CreatorRef, MemberRef, HandshakeRef) name a row the core already has: its UUID, the external id and, where you keep a row of your own, your storageRef. The core hands them to your ports and the Core API hands them back from every read and write.
• Records (InstallationRecord, IdentityRecord, SpaceRecord, GrantRecord, CreatorRegistration) describe what the core should write. Every record() is idempotent on the natural key the page names: a second record of the same bot, account, place or grant updates the row rather than adding one, so a connector may record on every event and on every deploy.

Eloquent models never cross. A ref carries what a port needs to act; when a port needs more than a ref holds, the answer is a new field on the ref or a new read on the contract, never a query.

ExceptionsCopy Anchor Link

Every other refusal is a null read: a find*() that answers null means the core knows no such row, and the connector decides what that means for the event in hand.

What the contracts coverCopy Anchor Link

Installations, identities, spaces, resources, grants, creator registration, the dashboard sign-in from a connector's own login door, a member's standing and the plans on offer for a connector's member surface, alert routing, recovery coverage with the standby and replacement writes, the support inbox in both directions, the Referral Program as a member meets it and as a creator runs it, the Partner Program, Smart Links, Revenue Recovery on both sides, the payment-method rewrite, a project's payment methods set up from a creator surface, the inbox and the creator tasks as a creator surface reads them, the Pass Roster one date at a time as a creator surface walks it, a member's recovery email, the dated windows of access a connector mirrors onto its platform, Subscriby Copilot in the creator's chat and the dedupe gate a socket-fed connector records its events through. Everything a connector does against the core goes through these thirty contracts, and the tutorial walks the calls in the order a connector makes them.