List what an installation can do for the creator
/v1/projects/{project}/connectors/{key}/installation/actions in the Connectors API.
curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example/installation/actions \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN"A connector declares the things its installation can set up on its platform as data, so every surface offers them the same way: each action carries its key, the label a button says, a description of what will happen, the fields the creator fills in first (the same shape as the connector's install_fields) and the confirm question a client asks before running, with needs_confirmation saying whether to ask. The list is empty for a connector that offers none, while the connector is paused, and while the installation cannot act. Run one with the endpoint below.
Requires ability
The token must hold this ability, or the call is refused with 403.
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidThe connector key from the route.
Responses
200OKapplication/json
Array of InstallationActionResource
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
On this endpoint: RESOURCE_NOT_FOUND: with reason: unknown_connector, or 404 CONNECTOR_NOT_INSTALLED when the project does not run the connector.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on