Appearance
gitlab.push ​
Sync GitLab branch state from push webhook payload
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-gitlab |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | Yes | — | — |
event_type | string | Yes | — | — |
action | string | No | — | — |
payload | dict | Yes | — | — |
organization_uuid | uuid | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | Yes | — | — |
project_uuid | uuid | Yes | — | — |
branch_uuid | uuid | No | — | — |
gitlab_project_ref | string | No | — | — |
branch_name | string | No | — | — |
is_deleted | boolean | No | — | — |
is_created | boolean | No | — | — |
organization_uuid | uuid | No | — | — |
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 | — |
executing | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | executing | — |
executing | complete | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
GITLAB_PUSH_PROJECT_NOT_FOUND | GitLab project not found |
GITLAB_PUSH_REF_REQUIRED | GitLab push ref is required |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gitlab.push",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}