---
title: "Attach Source"
method: POST
path: "/api/py/delivery/sources/attach"
---

# Attach Source

`POST /api/py/delivery/sources/attach`

## Request body

- union
  - SalesforceOrgAttachBody
    - `source_type` 'salesforce_org', required
    - `instance_id` string, uuid, required
    - `payload` SalesforceClientCredentialsInput, required
      - `kind` 'client_credentials'
      - `my_domain_url` string, required
      - `client_id` string, required
      - `client_secret` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required
  - GithubRepoAttachBody
    - `source_type` 'github_repo', required
    - `instance_id` string, uuid, required
    - `payload` GithubRepoAttachPayload, required
      - `github_installation_id` string, uuid, required
      - `external_github_repo_id` string, required
      - `github_owner_login` string, required
      - `github_repo_name` string, required
      - `target_branch` string, required
  - NetsuiteAccountAttachBody
    - `source_type` 'netsuite_account', required
    - `instance_id` string, uuid, required
    - `payload` NetsuiteClientCredentialsInput, required
      - `kind` 'client_credentials'
      - `account_id` string, required
      - `client_id` string, required
      - `certificate_id` string, required
      - `private_key` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', nullable
    - `trigger_on_attach` boolean
  - ServicenowInstanceAttachBody
    - `source_type` 'servicenow_instance', required
    - `instance_id` string, uuid, required
    - `payload` ServicenowClientCredentialsInput, required
      - `kind` 'client_credentials'
      - `instance_url` string, required
      - `client_id` string, required
      - `client_secret` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required
  - AtlassianOrgAttachBody
    - `source_type` 'atlassian_org', required
    - `instance_id` string, uuid, required
    - `payload` AtlassianClientCredentialsInput, required
      - `kind` 'client_credentials'
      - `client_id` string, required
      - `client_secret` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required
  - AtlassianAdminAttachBody
    - `source_type` 'atlassian_admin', required
    - `instance_id` string, uuid, required
    - `payload` AtlassianAdminApiKeyInput, required
      - `kind` 'admin_api_key'
      - `api_key` string, required
      - `org_id` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required
  - WorkdayTenantAttachBody
    - `source_type` 'workday_tenant', required
    - `instance_id` string, uuid, required
    - `rest_api_endpoint` string, required
    - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required
    - `payload` WorkdayOAuthRefreshTokenInput, required
      - `kind` 'oauth_refresh_token'
      - `client_id` string, required
      - `client_secret` string, required
      - `refresh_token` string, required
  - HubspotAccountAttachBody
    - `source_type` 'hubspot_account', required
    - `instance_id` string, uuid, required
    - `payload` HubspotServiceKeyInput, required
      - `kind` 'service_key'
      - `service_key` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', required

## Response `200`

Successful Response

- AttachedSourceResponse
  - `id` string, uuid, required
  - `source_type` string, required
  - `delivery_instance_id` string, uuid, required
  - `organization_id` string, required
  - `credential_kind` string, required
  - `external_instance_url` string, nullable
  - `external_org_id` string, nullable
  - `external_my_domain_url` string, nullable
  - `external_account_id` string, nullable
  - `external_account_url` string, nullable
  - `environment` string, nullable, required
  - `status` string, required
  - `created_at` string, required
  - `updated_at` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/getauctor/apis/fastapi.md) · [All operations](https://skmtc.dev/getauctor/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getauctor/fastapi/revisions/aeb6faa3b8f0/schema)