Connectors

Install a connector

curl -X POST https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Installing and connecting are two acts. Installing says "this project runs this connector" and opens a pending installation with no credentials (201 with the installation; 200 with the existing one when it was already installed, nothing changed). Connecting, which hands the connector the creator's credentials, stays on the dashboard, where the connector's declared install_fields are rendered and the platform is asked to describe the installation before anything is bound; a REST client cannot prove a credential is its own to bind. An uninstalled connector installed again comes back as pending with its settings kept.

post/v1/projects/{project}/connectors/{key}

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/connectors/{key}
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

keystring required

The connector key from the route.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

201 with the installation; 200 when it was already installed.

string required

Changes

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