Connect a resource to a GitHub source
POST
/v1/source-control/bindingsCreates or replaces the single canonical GitHub binding for the resource. Outbound synchronization requires repository contents write permission, and pull-request publication requires pull requests write permission.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Computer-Agents-Organization | header | string | No | Active organization context. If omitted, the authenticated user's personal organization is used. |
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| resourceKind | function | web_app | skill | agent | computer | Yes | — |
| resourceId | string | Yes | — |
| repositoryFullName | string | Yes | — |
| baseBranch | string | No | — |
| rootPath | string | No | — |
| direction | github_to_resource | resource_to_github | bidirectional | No | — |
| conflictPolicy | fail | github_wins | resource_wins | No | — |
| enabled | boolean | No | — |
| configuration | object | No | — |
| configuration.inboundTriggers | manual | push | pull_request.merged | release.published[] | No | — |
| configuration.outboundTriggers | manual | resource.updated | resource.published[] | No | — |
| configuration.branchPrefix | string | No | — |
| configuration.createPullRequests | boolean | No | — |
| configuration.forcePush | boolean | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Source-control binding createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Unique identifier. |
| provider | github | Yes | — |
| resourceKind | function | web_app | skill | agent | computer | Yes | — |
| resourceId | string | Yes | — |
| organizationId | string | Yes | — |
| userId | string | Yes | User ID. |
| createdByUserId | string | Yes | — |
| repositoryFullName | string | Yes | — |
| repositoryExternalId | string | Yes | — |
| installationExternalId | string | Yes | — |
| baseBranch | string | Yes | — |
| rootPath | string | Yes | — |
| direction | github_to_resource | resource_to_github | bidirectional | Yes | — |
| conflictPolicy | fail | github_wins | resource_wins | Yes | — |
| enabled | boolean | Yes | — |
| configuration | object | Yes | — |
| configuration.inboundTriggers | manual | push | pull_request.merged | release.published[] | No | — |
| configuration.outboundTriggers | manual | resource.updated | resource.published[] | No | — |
| configuration.branchPrefix | string | No | — |
| configuration.createPullRequests | boolean | No | — |
| configuration.forcePush | boolean | No | — |
| state | object | Yes | — |
| state.lastGitHubSha | string | Yes | — |
| state.lastImportedSha | string | Yes | — |
| state.lastExportedSha | string | Yes | — |
| state.lastResourceRevision | string | Yes | — |
| state.managedPaths | string[] | Yes | — |
| state.lastSyncAt | string | Yes | — |
| state.lastSyncDirection | | github_to_resource | resource_to_github | Yes | — |
| state.lastStatus | | queued | running | succeeded | failed | ignored | conflicted | Yes | — |
| state.lastError | string | Yes | — |
| createdAt | string | Yes | ISO 8601 timestamp. |
| updatedAt | string | Yes | ISO 8601 timestamp. |
404Resource not foundapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
409Repository connection or GitHub App permissions must be updated
None.
Connect a resource to a GitHub source
Loading...
Response 201
Loading...