Skip to main content
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. CustomVCSIntegrationResponse

CustomVCSIntegrationResponse

    Response containing the details of a custom VCS integration, including its configuration, webhook endpoint, and configured repositories.

    Properties

    • id string required
      Unique identifier (UUID) for this integration
    • name string required
      Human-readable name for the integration
    • baseUrl string required
      URL prefix for repositories covered by this integration
    • environment string required
      ESC environment reference in ‘project/envName’ format containing VCS credentials
    • vcsType enum required
      Version control system type
      Values: git, hg
    • webhookUrl string optional
      Full webhook endpoint URL that the external VCS should POST events to. This URL is generated by the service and includes the integration ID.
    • webhookSecret string optional
      HMAC secret for webhook signature verification. Only returned on integration creation; subsequent GET requests omit this field.
    • repositories array[CustomVCSRepository] optional
      List of repositories configured on this integration
    • name string required
      Repository name or path, joined with the integration’s base URL to form the clone URL (e.g. ‘myrepo’ or ‘subgroup/myrepo’)
    • displayName string optional
      Human-readable display name for the repository. If not provided, the name is used for display purposes.
    • created string required
      ISO 8601 timestamp of when the integration was created
    • modified string required
      ISO 8601 timestamp of when the integration was last modified