HubSpot

Use hubspot in twins and put this configuration under seed_config.hubspot. HubSpot CRM with users, owners, teams, roles, contacts, companies, deals, tickets, activities, leads, products, line items, custom properties/schemas, pipelines, labeled associations, and contact lists.

Example seed

This is the complete Scenario request body for creating a Scenario. You can also import it with arga test-runner scenarios import --file scenario.json.

{
  "name": "HubSpot eval fixture",
  "twins": [
    "hubspot"
  ],
  "seed_config": {
    "hubspot": {
      "users": [
        {
          "id": 152000001,
          "email": "ada@example.com",
          "first_name": "Ada",
          "last_name": "Lovelace"
        }
      ],
      "owners": [
        {
          "id": 52000001,
          "email": "ada@example.com",
          "first_name": "Ada",
          "last_name": "Lovelace",
          "user_id": 152000001
        }
      ],
      "contacts": [
        {
          "properties": {
            "email": "ada@example.com",
            "firstname": "Ada",
            "lastname": "Lovelace",
            "lifecyclestage": "lead",
            "hubspot_owner_id": "52000001"
          }
        }
      ],
      "companies": [
        {
          "properties": {
            "name": "Analytical Engines",
            "domain": "analytical.example.com",
            "industry": "COMPUTER_SOFTWARE",
            "city": "London",
            "state": "Greater London",
            "country": "United Kingdom",
            "phone": "+44 20 7946 0958",
            "website": "https://analytical.example.com",
            "numberofemployees": "120",
            "annualrevenue": "25000000",
            "lifecyclestage": "customer",
            "hubspot_owner_id": "52000001",
            "description": "Builds analytical computing tools for research teams."
          }
        }
      ],
      "deals": [
        {
          "properties": {
            "dealname": "Enterprise pilot",
            "amount": "25000",
            "dealstage": "appointmentscheduled",
            "pipeline": "default",
            "hubspot_owner_id": "52000001"
          }
        }
      ],
      "tickets": [
        {
          "properties": {
            "subject": "Onboarding question",
            "content": "Customer asked about workspace setup.",
            "hs_pipeline_stage": "1"
          }
        }
      ],
      "associations": [
        {
          "contact_email": "ada@example.com",
          "company_domain": "analytical.example.com"
        },
        {
          "contact_email": "ada@example.com",
          "deal_name": "Enterprise pilot"
        },
        {
          "contact_email": "ada@example.com",
          "ticket_subject": "Onboarding question"
        }
      ],
      "lists": [
        {
          "name": "Pilot customers",
          "members": [
            "ada@example.com"
          ]
        }
      ]
    }
  }
}

Parameters

The following fields belong directly inside seed_config.hubspot. Required nested fields are marked in their tables. Provider-native objects can contain service-specific fields beyond the representative record shapes below.

Parameter	Type	Description
`users`	`SeedUser[]`	Users fixtures in provider-native format.
`owners`	`SeedOwner[]`	Owners fixtures in provider-native format.
`contacts`	`SeedRecord[]`	Contacts fixtures in provider-native format.
`companies`	`SeedRecord[]`	Companies fixtures in provider-native format.
`deals`	`SeedRecord[]`	Deals fixtures in provider-native format.
`tickets`	`SeedRecord[]`	Tickets fixtures in provider-native format.
`associations`	`SeedAssociation[]`	Associations fixtures in provider-native format.
`lists`	`SeedList[]`	Lists fixtures in provider-native format.
`include_default_properties`	`boolean`	Enable or set include default properties behavior.
`roles`	`SeedRole[]`	Role definitions and their supported relationships.
`teams`	`SeedTeam[]`	Teams fixtures in provider-native format.
`properties`	`map<string, SeedProperty[]>`	Properties keyed by identifier or resource name.
`property_groups`	`map<string, SeedPropertyGroup[]>`	Property groups keyed by identifier or resource name.
`schemas`	`SeedSchema[]`	Schemas fixtures in provider-native format.
`pipelines`	`map<string, SeedPipeline[]>`	Pipelines keyed by identifier or resource name.
`objects`	`map<string, SeedRecord[]>`	Objects keyed by identifier or resource name.
`emails`	`SeedRecord[]`	Emails fixtures in provider-native format.
`calls`	`SeedRecord[]`	Calls fixtures in provider-native format.
`communications`	`SeedRecord[]`	Communications fixtures in provider-native format.
`meetings`	`SeedRecord[]`	Meetings fixtures in provider-native format.
`tasks`	`SeedRecord[]`	Tasks fixtures in provider-native format.
`notes`	`SeedRecord[]`	Notes fixtures in provider-native format.
`leads`	`SeedRecord[]`	Leads fixtures in provider-native format.
`products`	`SeedRecord[]`	Products fixtures in provider-native format.
`line_items`	`SeedRecord[]`	Line items fixtures in provider-native format.
`seed`	`integer`	Deterministic seed used by this twin.
`base_time`	`string`	Reference clock for repeatable fixtures. Omit to use the current clock.
`hub_id`	`integer`	Hub id.
`hub_domain`	`string`	Hub domain.
`portal_id`	`integer or null`	Portal id.
`account_type`	`"STANDARD" / "DEVELOPER_TEST" / "SANDBOX" / "APP_DEVELOPER"`	Account type.
`time_zone`	`string`	Time zone.
`company_currency`	`string`	Company currency.
`additional_currencies`	`string[]`	Additional currencies fixtures in provider-native format.
`utc_offset`	`string`	Utc offset.
`utc_offset_milliseconds`	`integer`	Utc offset milliseconds.
`ui_domain`	`string`	Ui domain.
`data_hosting_location`	`string`	Data hosting location.
`app_id`	`integer`	App id.
`app_name`	`string`	App name.
`is_user_level`	`boolean`	Enable or set is user level behavior.
`client_id`	`string`	Test OAuth client identifier.
`client_secret`	`string`	Test OAuth client secret.
`developer_api_key`	`string`	Developer api key.
`allow_unknown_tokens`	`boolean`	Accept otherwise unknown credentials when supported.
`rate_limiting_enabled`	`boolean`	Enable request rate limiting.
`daily_limit`	`integer`	Daily limit.
`secondly_limit`	`integer`	Secondly limit.
`interval_max`	`integer`	Interval max.
`interval_milliseconds`	`integer`	Interval milliseconds.
`failure_rules`	`FailureRule[]`	Deterministic failure-injection rules.
`rate_limits`	`map<string, RateLimitRule>`	Request limits keyed by API method or endpoint.
`event_delivery`	`EventDeliveryConfig`	Event delivery ordering, batching, timing, and callback settings.
`tokens`	`SeedToken[]`	Test credentials, identity assignments, and permission scopes.

Resource fields

These tables describe the record shapes used by the example. Keep native field names and casing. Map keys such as property names, IDs, and metadata keys are supplied by your fixture.

`users[]`

Parameter	Type	Description
`id`	`integer`	Explicit resource identifier, when supported.
`email`	`string`	Main account email address.
`first_name`	`string`	First name.
`last_name`	`string`	Last name.

`owners[]`

Parameter	Type	Description
`id`	`integer`	Explicit resource identifier, when supported.
`email`	`string`	Main account email address.
`first_name`	`string`	First name.
`last_name`	`string`	Last name.
`user_id`	`integer`	User id.

`contacts[]`

Parameter	Type	Description
`properties`	`object`	Properties.

`companies[]`

Parameter	Type	Description
`properties`	`object`	Properties.

`deals[]`

Parameter	Type	Description
`properties`	`object`	Properties.

`tickets[]`

Parameter	Type	Description
`properties`	`object`	Properties.

`associations[]`

Parameter	Type	Description
`contact_email`	`string`	Contact email.
`company_domain`	`string`	Company domain.
`deal_name`	`string`	Deal name.
`ticket_subject`	`string`	Ticket subject.

`lists[]`

Parameter	Type	Description
`name`	`string`	Human-readable name.
`members`	`string[]`	Members fixtures in provider-native format.

Typed configuration objects

Named object types in the parameter table use these fields.

EventDeliveryConfig

Parameter	Type	Description
`auto_dispatch`	`boolean`	Enable or set auto dispatch behavior.
`ordering`	`"fifo" / "lifo"`	Ordering.
`target_url`	`string`	Target url.
`batch_size`	`integer`	Batch size.
`signing_app_secret`	`string`	Signing app secret.
`client_secret_fallback`	`string`	Client secret fallback.

FailureRule

Parameter	Type	Description
`method`	`string`	Required. Method. Minimum length: 1.
`status_code`	`integer`	Status code.
`error_category`	`string or null`	Error category.
`error_message`	`string or null`	Error message.
`body`	`object or null`	Text content.
`delay_ms`	`integer`	Delay ms.
`remaining_invocations`	`integer`	Remaining invocations.
`match_object_id`	`string or null`	Match object id.

RateLimitRule

Parameter	Type	Description
`window_seconds`	`integer`	Window seconds, in seconds.
`max_requests`	`integer`	Max requests.
`retry_after_seconds`	`integer`	Retry after seconds, in seconds.

SeedAssociation

Parameter	Type	Description
`from_type`	`string or null`	From type.
`from_id`	`integer or null`	From id.
`to_type`	`string or null`	To type.
`to_id`	`integer or null`	To id.
`association_type_id`	`integer or null`	Association type id.
`association_category`	`"HUBSPOT_DEFINED" / "USER_DEFINED"`	Association category.
`label`	`string or null`	Label.
`contact_email`	`string or null`	Contact email.
`company_domain`	`string or null`	Company domain.
`deal_name`	`string or null`	Deal name.
`ticket_subject`	`string or null`	Ticket subject.

SeedList

Parameter	Type	Description
`id`	`integer or null`	Explicit resource identifier, when supported.
`name`	`string`	Required. Human-readable name.
`objectTypeId`	`string`	ObjectTypeId.
`processingType`	`"MANUAL" / "DYNAMIC" / "SNAPSHOT"`	ProcessingType.
`filterBranch`	`object or null`	FilterBranch.
`members`	`integer or string[]`	Members fixtures in provider-native format.

SeedOwner

Parameter	Type	Description
`id`	`integer`	Required. Explicit resource identifier, when supported.
`email`	`string`	Required. Main account email address.
`first_name`	`string`	First name.
`last_name`	`string`	Last name.
`user_id`	`integer or null`	User id.
`teams`	`object[]`	Teams fixtures in provider-native format.
`archived`	`boolean`	Enable or set archived behavior.

SeedPipeline

Parameter	Type	Description
`id`	`string`	Required. Explicit resource identifier, when supported.
`label`	`string`	Required. Label.
`displayOrder`	`integer`	DisplayOrder.
`stages`	`SeedStage[]`	Stages fixtures in provider-native format.

SeedProperty

Parameter	Type	Description
`name`	`string`	Required. Human-readable name. Minimum length: 1.
`label`	`string`	Required. Label.
`type`	`string`	Type.
`fieldType`	`string`	FieldType.
`groupName`	`string`	GroupName.
`description`	`string`	Description.
`options`	`SeedOption[]`	Options fixtures in provider-native format.
`displayOrder`	`integer`	DisplayOrder.
`hasUniqueValue`	`boolean`	Enable or set hasUniqueValue behavior.
`hidden`	`boolean`	Enable or set hidden behavior.
`formField`	`boolean`	Enable or set formField behavior.
`calculated`	`boolean`	Enable or set calculated behavior.
`externalOptions`	`boolean`	Enable or set externalOptions behavior.
`referencedObjectType`	`string or null`	ReferencedObjectType.
`calculationFormula`	`string or null`	CalculationFormula.
`currencyPropertyName`	`string or null`	CurrencyPropertyName.
`showCurrencySymbol`	`boolean`	Enable or set showCurrencySymbol behavior.
`numberDisplayHint`	`string or null`	NumberDisplayHint.
`textDisplayHint`	`string or null`	TextDisplayHint.
`dateDisplayHint`	`string or null`	DateDisplayHint.
`sensitiveDataCategories`	`string[]`	SensitiveDataCategories fixtures in provider-native format.
`dataSensitivity`	`string`	DataSensitivity.
`createdUserId`	`string or null`	CreatedUserId.
`updatedUserId`	`string or null`	UpdatedUserId.
`archivedAt`	`string or null`	ArchivedAt.
`modificationMetadata`	`map<string, boolean>`	ModificationMetadata keyed by identifier or resource name.

SeedOption

Parameter	Type	Description
`label`	`string`	Required. Label.
`value`	`string`	Required. Value.
`description`	`string`	Description.
`displayOrder`	`integer`	DisplayOrder.
`hidden`	`boolean`	Enable or set hidden behavior.

SeedPropertyGroup

Parameter	Type	Description
`name`	`string`	Required. Human-readable name.
`label`	`string`	Required. Label.
`displayOrder`	`integer`	DisplayOrder.

SeedRecord

Parameter	Type	Description
`id`	`integer or null`	Explicit resource identifier, when supported.
`properties`	`map<string, string or integer or number or boolean or null>`	Properties keyed by identifier or resource name.
`createdAt`	`string or null`	CreatedAt.
`updatedAt`	`string or null`	UpdatedAt.
`archived`	`boolean`	Enable or set archived behavior.

SeedRole

Parameter	Type	Description
`id`	`string`	Required. Explicit resource identifier, when supported.
`name`	`string`	Required. Human-readable name.
`object_permissions`	`map<string, ObjectPermissions>`	Object permissions keyed by identifier or resource name.

ObjectPermissions

Parameter	Type	Description
`read`	`"all" / "team-owned" / "owned-only" / "none"`	Read.
`write`	`"all" / "team-owned" / "owned-only" / "none"`	Write.
`delete`	`"all" / "team-owned" / "owned-only" / "none"`	Delete.

SeedSchema

Parameter	Type	Description
`objectTypeId`	`string or null`	ObjectTypeId.
`name`	`string`	Required. Human-readable name.
`labels`	`map<string, string>`	Custom label names or objects containing name.
`primaryDisplayProperty`	`string`	PrimaryDisplayProperty.
`secondaryDisplayProperties`	`string[]`	SecondaryDisplayProperties fixtures in provider-native format.
`requiredProperties`	`string[]`	RequiredProperties fixtures in provider-native format.
`searchableProperties`	`string[]`	SearchableProperties fixtures in provider-native format.
`properties`	`SeedProperty[]`	Properties fixtures in provider-native format.

SeedStage

Parameter	Type	Description
`id`	`string`	Required. Explicit resource identifier, when supported.
`label`	`string`	Required. Label.
`displayOrder`	`integer`	DisplayOrder.
`metadata`	`map<string, string>`	Metadata keyed by identifier or resource name.

SeedTeam

Parameter	Type	Description
`id`	`string`	Required. Explicit resource identifier, when supported.
`name`	`string`	Required. Human-readable name.
`user_ids`	`integer[]`	User ids fixtures in provider-native format.
`secondary_user_ids`	`integer[]`	Secondary user ids fixtures in provider-native format.

SeedToken

Parameter	Type	Description
`token`	`string`	Required. Token.
`user_id`	`integer`	User id.
`scopes`	`string[]`	Scopes fixtures in provider-native format.
`is_developer_key`	`boolean`	Enable or set is developer key behavior.
`refresh_token`	`string or null`	Refresh token.
`expires_in`	`integer`	Expires in. Minimum: 1.
`is_oauth_access_token`	`boolean or null`	Is oauth access token.
`is_user_level`	`boolean`	Enable or set is user level behavior.

SeedUser

Parameter	Type	Description
`id`	`integer`	Required. Explicit resource identifier, when supported.
`email`	`string`	Required. Main account email address.
`first_name`	`string`	First name.
`last_name`	`string`	Last name.
`role_id`	`string or null`	Role id.
`primary_team_id`	`string or null`	Primary team id.
`secondary_team_ids`	`string[]`	Secondary team ids fixtures in provider-native format.
`super_admin`	`boolean`	Enable or set super admin behavior.
`can_edit_associations`	`boolean`	Enable or set can edit associations behavior.

See Scenario seeding for saving, provisioning, and resetting fixtures.

Get started

Digital twins

Tests

Setup

Integrations

Resources

Example seed

Parameters

Resource fields

`users[]`

`owners[]`

`contacts[]`

`companies[]`

`deals[]`

`tickets[]`

`associations[]`

`lists[]`

Typed configuration objects

EventDeliveryConfig

FailureRule

RateLimitRule

SeedAssociation

SeedList

SeedOwner

SeedPipeline

SeedProperty

SeedOption

SeedPropertyGroup

SeedRecord

SeedRole

ObjectPermissions

SeedSchema

SeedStage

SeedTeam

SeedToken

SeedUser

​Example seed

​Parameters

​Resource fields

​users[]

​owners[]

​contacts[]

​companies[]

​deals[]

​tickets[]

​associations[]

​lists[]

​Typed configuration objects

​EventDeliveryConfig

​FailureRule

​RateLimitRule

​SeedAssociation

​SeedList

​SeedOwner

​SeedPipeline

​SeedProperty

​SeedOption

​SeedPropertyGroup

​SeedRecord

​SeedRole

​ObjectPermissions

​SeedSchema

​SeedStage

​SeedTeam

​SeedToken

​SeedUser

Example seed

Parameters

Resource fields

`users[]`

`owners[]`

`contacts[]`

`companies[]`

`deals[]`

`tickets[]`

`associations[]`

`lists[]`

Typed configuration objects

EventDeliveryConfig

FailureRule

RateLimitRule

SeedAssociation

SeedList

SeedOwner

SeedPipeline

SeedProperty

SeedOption

SeedPropertyGroup

SeedRecord

SeedRole

ObjectPermissions

SeedSchema

SeedStage

SeedTeam

SeedToken

SeedUser