Appearance
github.installation-finalize ​
Link a GitHub App installation to an organization once the signed webhook has arrived
Finalize a GitHub App installation after GitHub redirects back to Orkestia
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | — |
github_installation_ref | integer | No | — | — |
setup_action | string | No | — | — |
state | string | No | — | SPA install nonce echoed by GitHub |
code | string | No | — | GitHub OAuth code (OAuth-on-install) |
actor | string | No | — | — |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | Yes | — | — |
github_installation_ref | integer | No | — | — |
installation_uuid | uuid | No | — | — |
connection_uuid | uuid | No | — | — |
account_login | string | No | — | — |
repository_count | integer | No | — | — |
retryable | boolean | No | — | — |
message | string | No | — | — |
finalized_at | string | No | — | — |
workflow_run_id | string | No | — | Parent DAG run ID |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
ORGANIZATION_NOT_FOUND | Organization {organization_uuid} not found |
INSTALLATION_REF_REQUIRED | github_installation_ref is required unless setup_action=request |
INSTALLATION_ALREADY_LINKED | GitHub installation {github_installation_ref} is already linked to another organization |
GITHUB_INSTALLATION_AUTHORIZATION_REQUIRED | A verified GitHub App user authorization callback is required |
GITHUB_INSTALLATION_AUTHORIZATION_FAILED | GitHub App user authorization could not be verified |
GITHUB_INSTALLATION_ACCESS_DENIED | The authenticated GitHub user cannot access installation |
GITHUB_INSTALLATION_INTENT_CONFLICT | The GitHub installation callback does not match its original organization intent |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.installation-finalize",
"initial_data": {
"organization_uuid": "value"
}
}