Connectors
Get one connector
One card by key, registered or on the roadmap, in the shape the directory lists.
curl https://api.subscriby.net/v1/connectors/example \
-H "Authorization: Bearer $SUBSCRIBY_TOKEN"
The manifest
Every key from install_mode onward describes what a registered connector can do; a roadmap card has them null or empty.
- install_mode: paste_credential (the creator pastes a token the platform issued), oauth (the creator authorises an app), shared_platform (Subscriby runs one shared presence; nothing to connect).
- scopes: project for an installation a creator sets up on a project; platform for a presence Subscriby itself runs on the connector.
- resource_kinds: the kinds of place the connector gates, with the creator-facing label, the portal_label members see, an icon slug, the grant_mode (bearer_link: a single-use link; membership: the connector admits the member itself; role: a role is granted; creator_task: the creator hands access over by hand), whether a grant can be held ahead of a pass window (supports_early_admission_hold), the kind of the same connector a place of this kind can be an in-place upgrade of (upgrades_from, or null), and the shapes of plan a place of the kind can be sold under (plan_kinds: one_time, recurring, pass, pass_series, in that order). A resource's kind on the Resources endpoints is <key>:<kind>, and the same spelling is what a link request takes. Labels are translated into the token holder's language.
- capabilities: the port families the connector implements: messaging, broadcasts, access_control, early_admission_hold, support_relay, native_payments, portal_login, creator_registration, management_surface, recovery_probes, recovery_standby_installations, recovery_resource_standby, recovery_mirror, recovery_identity_relink.
- messaging and pacing: the limits every message and every bulk send is checked against.
- management_commands and missing_commands: which core commands the connector's in-chat surface renders and which it does not; the docs' capability matrix and the Connectors tab show the gaps from these.
- recovery: which Disaster Recovery facets the connector implements.
- portal_cta: the button the member portal shows to open the connector (label, translated, and icon), or null when the connector has nowhere to open; the portal addresses it through the installation's start link.
- install_fields and settings_fields: the declarative forms. Each field carries type (text, secret, select, toggle, instructions, link), a translated label and help, required, the validation rules, options for a select, a default value, the numbered walkthrough steps (with :app and :button placeholders for the app's name and the submit button's label) and links naming the text a renderer turns into a link. Render them in order and you have the connect form the dashboard shows.
get/v1/connectors/{key}
Request
- Base URL: https://api.subscriby.net
- URL: https://api.subscriby.net/v1/connectors/{key}
- Auth: HTTP bearer
Path parameters
keystring required
The connector key from the route.
Response
200 with the card.
Example response
{
"data": {
"key": "example",
"name": "Example",
"vendor": "Subscriby",
"version": "1.0.0",
"status": "available",
"status_label": "Available Now",
"installable": true,
"official": true,
"installations": 1284,
"category": "messaging",
"tagline": "Sell access to channels and groups through your own bot.",
"overview": "Connect a bot you created on the platform and Subscriby runs your membership there: …",
"icon": "example",
"links": {
"documentation": "https://docs.subscriby.net/connectors/example",
"support": "mailto:support@subscriby.net",
"privacy": "https://example.org/privacy",
"terms": "https://example.org/tos",
"homepage": "https://example.org"
},
"added_at": "2025-04-21",
"changelog_url": "https://www.subscriby.net/blog",
"portal_cta": {
"label": "Open the app",
"icon": "example"
},
"install_mode": "paste_credential",
"scopes": [
"project"
],
"capabilities": [
"messaging"
],
"messaging": {
"max_length": 4096,
"buttons_per_row": 8,
"max_buttons": 100,
"callback_data_bytes": 64,
"supports_underline": true,
"supports_spoiler": true,
"supports_files": true
},
"pacing": {
"min_interval_microseconds": 35000,
"burst": 30,
"per_recipient_interval_microseconds": 1000000
},
"management_commands": [
"project_create"
],
"missing_commands": [
"manage_connectors"
],
"relay_modes": [
"owner_dm"
],
"recovery": {
"probes": true,
"standby_installations": true,
"resource_standby": true,
"mirror": true,
"identity_relink": true
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.