Integrations
Connect an installed app
The integration's name is the vendor account's login, lowercased.
- INVALID_ARGUMENT when the callback variant does not match
kind. - FAILED_PRECONDITION when the state is invalid or expired, or the vendor rejected the code. Install again.
- PERMISSION_DENIED when the state belongs to another organization or user, or the installation is not the user's.
- ALREADY_EXISTS when another organization holds this installation.
- OK with the existing integration when this organization already holds it, including a reinstall of a disconnected one.
Scope: integration:write
Authorization
bearerAuth AuthorizationBearer <token>
An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
callback_matches_kind // the callback variant must match kind
callback_matches_kind // the callback variant must match kind
Response Body
application/json
curl -X POST "https://example.com/v1/integrations/connect" \ -H "Content-Type: application/json" \ -d '{ "kind": "KIND_UNSPECIFIED", "state": "string", "code": "string" }'{ "integration": { "id": "string", "name": "string", "kind": "KIND_UNSPECIFIED", "status": "STATUS_UNSPECIFIED", "status_reason": "string", "settings": { "github": { "installation_id": "string", "account_login": "string", "account_type": "ACCOUNT_TYPE_UNSPECIFIED", "repository_selection": "REPOSITORY_SELECTION_UNSPECIFIED", "repositories": [ "string" ], "url": "string", "suspended_at": "2023-01-15T01:30:15.01Z" } }, "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z" }}