Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceHubspot
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceHubspot

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceHubspot Resource

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceHubspot;
import com.pulumi.airbyte.SourceHubspotArgs;
import com.pulumi.airbyte.inputs.SourceHubspotConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceHubspotConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceHubspotConfigurationCredentialsOAuthArgs;
import com.pulumi.airbyte.inputs.SourceHubspotConfigurationCredentialsPrivateAppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceHubspot = new SourceHubspot("mySourceHubspot", SourceHubspotArgs.builder()
            .configuration(SourceHubspotConfigurationArgs.builder()
                .credentials(SourceHubspotConfigurationCredentialsArgs.builder()
                    .oAuth(SourceHubspotConfigurationCredentialsOAuthArgs.builder()
                        .clientId("123456789000")
                        .clientSecret("secret")
                        .refreshToken("refresh_token")
                        .build())
                    .privateApp(SourceHubspotConfigurationCredentialsPrivateAppArgs.builder()
                        .accessToken("...my_access_token...")
                        .build())
                    .build())
                .enable_experimental_streams(false)
                .start_date("2017-01-25T00:00:00Z")
                .build())
            .definitionId("5a78ec38-3a27-4695-8c44-7a6d7e5af928")
            .secretId("...my_secret_id...")
            .workspaceId("5867a7a3-cda1-42de-aa60-dea6430ea0d1")
            .build());

    }
}

    resources:
  mySourceHubspot:
    type: airbyte:SourceHubspot
    properties:
      configuration:
        credentials:
          oAuth:
            clientId: '123456789000'
            clientSecret: secret
            refreshToken: refresh_token
          privateApp:
            accessToken: '...my_access_token...'
        enable_experimental_streams: false
        start_date: 2017-01-25T00:00:00Z
      definitionId: 5a78ec38-3a27-4695-8c44-7a6d7e5af928
      secretId: '...my_secret_id...'
      workspaceId: 5867a7a3-cda1-42de-aa60-dea6430ea0d1

    Create SourceHubspot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SourceHubspot(name: string, args: SourceHubspotArgs, opts?: CustomResourceOptions);
    @overload
def SourceHubspot(resource_name: str,
                  args: SourceHubspotArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceHubspot(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceHubspotConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
    func NewSourceHubspot(ctx *Context, name string, args SourceHubspotArgs, opts ...ResourceOption) (*SourceHubspot, error)
    public SourceHubspot(string name, SourceHubspotArgs args, CustomResourceOptions? opts = null)
    public SourceHubspot(String name, SourceHubspotArgs args)
public SourceHubspot(String name, SourceHubspotArgs args, CustomResourceOptions options)

    type: airbyte:SourceHubspot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SourceHubspotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceHubspotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceHubspotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceHubspotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceHubspotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sourceHubspotResource = new Airbyte.SourceHubspot("sourceHubspotResource", new()
{
    Configuration = new Airbyte.Inputs.SourceHubspotConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceHubspotConfigurationCredentialsArgs
        {
            OAuth = new Airbyte.Inputs.SourceHubspotConfigurationCredentialsOAuthArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
            },
            PrivateApp = new Airbyte.Inputs.SourceHubspotConfigurationCredentialsPrivateAppArgs
            {
                AccessToken = "string",
            },
        },
        EnableExperimentalStreams = false,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceHubspot(ctx, "sourceHubspotResource", &airbyte.SourceHubspotArgs{
Configuration: &.SourceHubspotConfigurationArgs{
Credentials: &.SourceHubspotConfigurationCredentialsArgs{
OAuth: &.SourceHubspotConfigurationCredentialsOAuthArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
},
PrivateApp: &.SourceHubspotConfigurationCredentialsPrivateAppArgs{
AccessToken: pulumi.String("string"),
},
},
EnableExperimentalStreams: pulumi.Bool(false),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceHubspotResource = new SourceHubspot("sourceHubspotResource", SourceHubspotArgs.builder()
    .configuration(SourceHubspotConfigurationArgs.builder()
        .credentials(SourceHubspotConfigurationCredentialsArgs.builder()
            .oAuth(SourceHubspotConfigurationCredentialsOAuthArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .build())
            .privateApp(SourceHubspotConfigurationCredentialsPrivateAppArgs.builder()
                .accessToken("string")
                .build())
            .build())
        .enableExperimentalStreams(false)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_hubspot_resource = airbyte.SourceHubspot("sourceHubspotResource",
    configuration={
        "credentials": {
            "o_auth": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
            },
            "private_app": {
                "access_token": "string",
            },
        },
        "enable_experimental_streams": False,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceHubspotResource = new airbyte.SourceHubspot("sourceHubspotResource", {
    configuration: {
        credentials: {
            oAuth: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
            },
            privateApp: {
                accessToken: "string",
            },
        },
        enableExperimentalStreams: false,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceHubspot
properties:
    configuration:
        credentials:
            oAuth:
                clientId: string
                clientSecret: string
                refreshToken: string
            privateApp:
                accessToken: string
        enableExperimentalStreams: false
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

    SourceHubspot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SourceHubspot resource accepts the following input properties:

    Configuration SourceHubspotConfiguration
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    Configuration SourceHubspotConfigurationArgs
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceHubspotConfiguration
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceHubspotConfiguration
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceHubspotConfigurationArgs
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration Property Map
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceHubspot resource produces the following output properties:

    CreatedAt double
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    CreatedAt float64
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    createdAt Double
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String
    createdAt number
    id string
    The provider-assigned unique ID for this managed resource.
    sourceId string
    sourceType string
    created_at float
    id str
    The provider-assigned unique ID for this managed resource.
    source_id str
    source_type str
    createdAt Number
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String

    Look up Existing SourceHubspot Resource

    Get an existing SourceHubspot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SourceHubspotState, opts?: CustomResourceOptions): SourceHubspot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceHubspotConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceHubspot
    func GetSourceHubspot(ctx *Context, name string, id IDInput, state *SourceHubspotState, opts ...ResourceOption) (*SourceHubspot, error)
    public static SourceHubspot Get(string name, Input<string> id, SourceHubspotState? state, CustomResourceOptions? opts = null)
    public static SourceHubspot get(String name, Output<String> id, SourceHubspotState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceHubspot    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration SourceHubspotConfiguration
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    Configuration SourceHubspotConfigurationArgs
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    configuration SourceHubspotConfiguration
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String
    configuration SourceHubspotConfiguration
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId string
    sourceType string
    workspaceId string
    configuration SourceHubspotConfigurationArgs
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    source_id str
    source_type str
    workspace_id str
    configuration Property Map
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String

    Supporting Types

    SourceHubspotConfiguration, SourceHubspotConfigurationArgs

    Credentials SourceHubspotConfigurationCredentials
    Choose how to authenticate to HubSpot.
    EnableExperimentalStreams bool
    If enabled then experimental streams become available for sync. Default: false
    StartDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
    Credentials SourceHubspotConfigurationCredentials
    Choose how to authenticate to HubSpot.
    EnableExperimentalStreams bool
    If enabled then experimental streams become available for sync. Default: false
    StartDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
    credentials SourceHubspotConfigurationCredentials
    Choose how to authenticate to HubSpot.
    enableExperimentalStreams Boolean
    If enabled then experimental streams become available for sync. Default: false
    startDate String
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
    credentials SourceHubspotConfigurationCredentials
    Choose how to authenticate to HubSpot.
    enableExperimentalStreams boolean
    If enabled then experimental streams become available for sync. Default: false
    startDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
    credentials SourceHubspotConfigurationCredentials
    Choose how to authenticate to HubSpot.
    enable_experimental_streams bool
    If enabled then experimental streams become available for sync. Default: false
    start_date str
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.
    credentials Property Map
    Choose how to authenticate to HubSpot.
    enableExperimentalStreams Boolean
    If enabled then experimental streams become available for sync. Default: false
    startDate String
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.

    SourceHubspotConfigurationCredentials, SourceHubspotConfigurationCredentialsArgs

    SourceHubspotConfigurationCredentialsOAuth, SourceHubspotConfigurationCredentialsOAuthArgs

    ClientId string
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    ClientSecret string
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    RefreshToken string
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    ClientId string
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    ClientSecret string
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    RefreshToken string
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    clientId String
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    clientSecret String
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    refreshToken String
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    clientId string
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    clientSecret string
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    refreshToken string
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    client_id str
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    client_secret str
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    refresh_token str
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    clientId String
    The Client ID of your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this ID.
    clientSecret String
    The client secret for your HubSpot developer application. See the \n\nHubspot docs\n\n if you need help finding this secret.
    refreshToken String
    Refresh token to renew an expired access token. See the \n\nHubspot docs\n\n if you need help finding this token.

    SourceHubspotConfigurationCredentialsPrivateApp, SourceHubspotConfigurationCredentialsPrivateAppArgs

    AccessToken string
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    AccessToken string
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    accessToken String
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    accessToken string
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    access_token str
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.
    accessToken String
    HubSpot Access token. See the \n\nHubspot docs\n\n if you need help finding this token.

    Import

    $ pulumi import airbyte:index/sourceHubspot:SourceHubspot my_airbyte_source_hubspot ""

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte