Federation

Create a federation subscription

Provisions a dedicated shadow workspace for this subscription and returns the webhook secret only this once. sourceInstanceUrl must be https:// by default (T602) — the subscriber's real bearer API key is sent to it on every scheduled pull.

post/api/federation/subscriptions

Request

  • Base URL: http://localhost:38200
  • URL: http://localhost:38200/api/federation/subscriptions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Request body

namestring required
sourceInstanceUrlstring required
remoteWorkspacestring
apiKeystring required

Plaintext API key issued by the remote instance's operator. Encrypted at rest.

pollIntervalMinutesinteger

Response

Created subscription plus the webhook secret (shown once).

idinteger
tenantIdinteger
namestring
sourceInstanceUrlstring
remoteWorkspacestring
shadowWorkspaceIdinteger
signingKeyIdstring nullable
signingPubkeystring nullable
cursorstring date-time nullable
pollIntervalMinutesinteger
status'active' | 'paused' | 'revoked'
webhookSecretstring nullable
lastSyncedAtstring date-time nullable
lastSyncStatusstring nullable
lastSyncErrorstring nullable
lastSyncStatsobject nullable
createdByUserIdinteger nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.