Authentication #

Configuration #

kind: source
spec:
  name: "bamboo-hr"
  path: "cloudquery/bamboo-hr"
  version: "v1.7.23"
  destinations:
    - "postgresql"
  tables: ["*"]
  # Learn more about the configuration options at https://cql.ink/bamboo-hr_source
  spec:
    # Optional parameters
    # concurrency: 100
    # table_options:
    #   employees:
    #     fields: 
    #       - firstName
    #       - lastName
    #       - customField1
    #       - customField2
    api_key: "<YOU_API_KEY>"
    subdomain: "<YOUR_COMPANY_SUBDOMAIN>"

BambooHR Spec #

• api_key (string) (required):

  Your user's API Key to authenticate to BambooHR.
• subdomain (string) (required):

  Your company's subdomain. If you access BambooHR via: https://mycompany.bamboohr.com, your subdomain is "mycompany".
• concurrency (integer, optional, default: 100): A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string, optional, default: dfs): The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.
• table_options (object) (optional):

  Options to apply to specific tables. Use it to select a custom list of fields for the employees table:

    table_options:
      employees:
        fields: 
          - firstName
          - lastName
          - customField1
          - customField2
  

  By default, the field list is the default list defined in BambooHR's API docs. The id field is always returned, regardless of it being included in the list.