Connectors API
A Subscriby project runs on connectors: the platforms it gates access on, sends messages through and takes payments from.
A Subscriby project runs on connectors: the platforms it gates access on, sends messages through and takes payments from. The directory these endpoints serve is the same one the dashboard and the marketing site render, so a client reads one document and knows which connectors exist, which a creator may install today, what each can do, and exactly which fields connecting one asks for. The manifest is served whole because the creator apps render the connect form from it: no client has to know what a "bot token" is before the connector says so.
The catalogue is the same for every creator and never carries a credential. A project's installations are what the Connectors tab lists: every connector set up on the project, live and standby, with its state and health.
Endpoints
/v1/connectorsList the connector directoryGET/v1/connectors/{key}Get one connectorGET/v1/projects/{project}/connectorsList a project's installationsGET/v1/projects/{project}/connectors/{key}/installationGet a project's installation of a connectorDELETE/v1/projects/{project}/connectors/{key}/installationDisconnect an installationGET/v1/projects/{project}/connectors/{key}/uninstall-previewPreview an uninstallPOST/v1/projects/{project}/connectors/{key}Install a connectorDELETE/v1/projects/{project}/connectors/{key}Uninstall a connectorPOST/v1/projects/{project}/connectors/{key}/installation/verifyVerify an installationPOST/v1/projects/{project}/connectors/{key}/installation/doctorRun the connector doctorPOST/v1/projects/{project}/connectors/{key}/installation/restore-accessRestore access after a reinstallPATCH/v1/projects/{project}/connectors/{key}/installation/settingsChange an installation's settingsRelated
How is this guide?
Last updated on