1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceZendeskSupport
Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq
airbyte logo
Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq

    SourceZendeskSupport Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const mySourceZendesksupport = new airbyte.SourceZendeskSupport("my_source_zendesksupport", {
        configuration: {
            additionalProperties: "{ \"see\": \"documentation\" }",
            credentials: {
                oAuth20Legacy: {
                    accessToken: "...my_access_token...",
                    additionalProperties: "{ \"see\": \"documentation\" }",
                    clientId: "...my_client_id...",
                    clientSecret: "...my_client_secret...",
                },
            },
            ignorePagination: true,
            numWorkers: 1,
            pageSize: 100,
            startDate: "2020-10-15T00:00:00Z",
            subdomain: "...my_subdomain...",
        },
        definitionId: "2f4827bb-f12c-45a8-a7c8-fc92af717ff3",
        name: "...my_name...",
        secretId: "...my_secret_id...",
        workspaceId: "88e43c5a-c5bf-4914-bf88-1d261e2148a9",
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_source_zendesksupport = airbyte.SourceZendeskSupport("my_source_zendesksupport",
        configuration={
            "additional_properties": "{ \"see\": \"documentation\" }",
            "credentials": {
                "o_auth20_legacy": {
                    "access_token": "...my_access_token...",
                    "additional_properties": "{ \"see\": \"documentation\" }",
                    "client_id": "...my_client_id...",
                    "client_secret": "...my_client_secret...",
                },
            },
            "ignore_pagination": True,
            "num_workers": 1,
            "page_size": 100,
            "start_date": "2020-10-15T00:00:00Z",
            "subdomain": "...my_subdomain...",
        },
        definition_id="2f4827bb-f12c-45a8-a7c8-fc92af717ff3",
        name="...my_name...",
        secret_id="...my_secret_id...",
        workspace_id="88e43c5a-c5bf-4914-bf88-1d261e2148a9")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := airbyte.NewSourceZendeskSupport(ctx, "my_source_zendesksupport", &airbyte.SourceZendeskSupportArgs{
    			Configuration: &airbyte.SourceZendeskSupportConfigurationArgs{
    				AdditionalProperties: pulumi.String("{ \"see\": \"documentation\" }"),
    				Credentials: &airbyte.SourceZendeskSupportConfigurationCredentialsArgs{
    					OAuth20Legacy: &airbyte.SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs{
    						AccessToken:          pulumi.String("...my_access_token..."),
    						AdditionalProperties: pulumi.String("{ \"see\": \"documentation\" }"),
    						ClientId:             pulumi.String("...my_client_id..."),
    						ClientSecret:         pulumi.String("...my_client_secret..."),
    					},
    				},
    				IgnorePagination: pulumi.Bool(true),
    				NumWorkers:       pulumi.Float64(1),
    				PageSize:         pulumi.Float64(100),
    				StartDate:        pulumi.String("2020-10-15T00:00:00Z"),
    				Subdomain:        pulumi.String("...my_subdomain..."),
    			},
    			DefinitionId: pulumi.String("2f4827bb-f12c-45a8-a7c8-fc92af717ff3"),
    			Name:         pulumi.String("...my_name..."),
    			SecretId:     pulumi.String("...my_secret_id..."),
    			WorkspaceId:  pulumi.String("88e43c5a-c5bf-4914-bf88-1d261e2148a9"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Airbyte = Pulumi.Airbyte;
    
    return await Deployment.RunAsync(() => 
    {
        var mySourceZendesksupport = new Airbyte.SourceZendeskSupport("my_source_zendesksupport", new()
        {
            Configuration = new Airbyte.Inputs.SourceZendeskSupportConfigurationArgs
            {
                AdditionalProperties = "{ \"see\": \"documentation\" }",
                Credentials = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsArgs
                {
                    OAuth20Legacy = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs
                    {
                        AccessToken = "...my_access_token...",
                        AdditionalProperties = "{ \"see\": \"documentation\" }",
                        ClientId = "...my_client_id...",
                        ClientSecret = "...my_client_secret...",
                    },
                },
                IgnorePagination = true,
                NumWorkers = 1,
                PageSize = 100,
                StartDate = "2020-10-15T00:00:00Z",
                Subdomain = "...my_subdomain...",
            },
            DefinitionId = "2f4827bb-f12c-45a8-a7c8-fc92af717ff3",
            Name = "...my_name...",
            SecretId = "...my_secret_id...",
            WorkspaceId = "88e43c5a-c5bf-4914-bf88-1d261e2148a9",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.airbyte.SourceZendeskSupport;
    import com.pulumi.airbyte.SourceZendeskSupportArgs;
    import com.pulumi.airbyte.inputs.SourceZendeskSupportConfigurationArgs;
    import com.pulumi.airbyte.inputs.SourceZendeskSupportConfigurationCredentialsArgs;
    import com.pulumi.airbyte.inputs.SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs;
    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 mySourceZendesksupport = new SourceZendeskSupport("mySourceZendesksupport", SourceZendeskSupportArgs.builder()
                .configuration(SourceZendeskSupportConfigurationArgs.builder()
                    .additionalProperties("{ \"see\": \"documentation\" }")
                    .credentials(SourceZendeskSupportConfigurationCredentialsArgs.builder()
                        .oAuth20Legacy(SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs.builder()
                            .accessToken("...my_access_token...")
                            .additionalProperties("{ \"see\": \"documentation\" }")
                            .clientId("...my_client_id...")
                            .clientSecret("...my_client_secret...")
                            .build())
                        .build())
                    .ignorePagination(true)
                    .numWorkers(1.0)
                    .pageSize(100.0)
                    .startDate("2020-10-15T00:00:00Z")
                    .subdomain("...my_subdomain...")
                    .build())
                .definitionId("2f4827bb-f12c-45a8-a7c8-fc92af717ff3")
                .name("...my_name...")
                .secretId("...my_secret_id...")
                .workspaceId("88e43c5a-c5bf-4914-bf88-1d261e2148a9")
                .build());
    
        }
    }
    
    resources:
      mySourceZendesksupport:
        type: airbyte:SourceZendeskSupport
        name: my_source_zendesksupport
        properties:
          configuration:
            additionalProperties: '{ "see": "documentation" }'
            credentials:
              oAuth20Legacy:
                accessToken: '...my_access_token...'
                additionalProperties: '{ "see": "documentation" }'
                clientId: '...my_client_id...'
                clientSecret: '...my_client_secret...'
            ignorePagination: true
            numWorkers: 1
            pageSize: 100
            startDate: 2020-10-15T00:00:00Z
            subdomain: '...my_subdomain...'
          definitionId: 2f4827bb-f12c-45a8-a7c8-fc92af717ff3
          name: '...my_name...'
          secretId: '...my_secret_id...'
          workspaceId: 88e43c5a-c5bf-4914-bf88-1d261e2148a9
    

    Create SourceZendeskSupport Resource

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

    Constructor syntax

    new SourceZendeskSupport(name: string, args: SourceZendeskSupportArgs, opts?: CustomResourceOptions);
    @overload
    def SourceZendeskSupport(resource_name: str,
                             args: SourceZendeskSupportArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def SourceZendeskSupport(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             configuration: Optional[SourceZendeskSupportConfigurationArgs] = None,
                             workspace_id: Optional[str] = None,
                             definition_id: Optional[str] = None,
                             name: Optional[str] = None,
                             secret_id: Optional[str] = None)
    func NewSourceZendeskSupport(ctx *Context, name string, args SourceZendeskSupportArgs, opts ...ResourceOption) (*SourceZendeskSupport, error)
    public SourceZendeskSupport(string name, SourceZendeskSupportArgs args, CustomResourceOptions? opts = null)
    public SourceZendeskSupport(String name, SourceZendeskSupportArgs args)
    public SourceZendeskSupport(String name, SourceZendeskSupportArgs args, CustomResourceOptions options)
    
    type: airbyte:SourceZendeskSupport
    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 SourceZendeskSupportArgs
    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 SourceZendeskSupportArgs
    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 SourceZendeskSupportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceZendeskSupportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceZendeskSupportArgs
    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 sourceZendeskSupportResource = new Airbyte.SourceZendeskSupport("sourceZendeskSupportResource", new()
    {
        Configuration = new Airbyte.Inputs.SourceZendeskSupportConfigurationArgs
        {
            Subdomain = "string",
            AdditionalProperties = "string",
            Credentials = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsArgs
            {
                ApiToken = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsApiTokenArgs
                {
                    ApiToken = "string",
                    Email = "string",
                    AdditionalProperties = "string",
                },
                OAuth20Legacy = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs
                {
                    AccessToken = "string",
                    AdditionalProperties = "string",
                    ClientId = "string",
                    ClientSecret = "string",
                },
                OAuth20WithRefreshToken = new Airbyte.Inputs.SourceZendeskSupportConfigurationCredentialsOAuth20WithRefreshTokenArgs
                {
                    ClientId = "string",
                    ClientSecret = "string",
                    RefreshToken = "string",
                    AccessToken = "string",
                    AdditionalProperties = "string",
                    TokenExpiryDate = "string",
                },
            },
            IgnorePagination = false,
            NumWorkers = 0,
            PageSize = 0,
            StartDate = "string",
        },
        WorkspaceId = "string",
        DefinitionId = "string",
        Name = "string",
        SecretId = "string",
    });
    
    example, err := airbyte.NewSourceZendeskSupport(ctx, "sourceZendeskSupportResource", &airbyte.SourceZendeskSupportArgs{
    	Configuration: &airbyte.SourceZendeskSupportConfigurationArgs{
    		Subdomain:            pulumi.String("string"),
    		AdditionalProperties: pulumi.String("string"),
    		Credentials: &airbyte.SourceZendeskSupportConfigurationCredentialsArgs{
    			ApiToken: &airbyte.SourceZendeskSupportConfigurationCredentialsApiTokenArgs{
    				ApiToken:             pulumi.String("string"),
    				Email:                pulumi.String("string"),
    				AdditionalProperties: pulumi.String("string"),
    			},
    			OAuth20Legacy: &airbyte.SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs{
    				AccessToken:          pulumi.String("string"),
    				AdditionalProperties: pulumi.String("string"),
    				ClientId:             pulumi.String("string"),
    				ClientSecret:         pulumi.String("string"),
    			},
    			OAuth20WithRefreshToken: &airbyte.SourceZendeskSupportConfigurationCredentialsOAuth20WithRefreshTokenArgs{
    				ClientId:             pulumi.String("string"),
    				ClientSecret:         pulumi.String("string"),
    				RefreshToken:         pulumi.String("string"),
    				AccessToken:          pulumi.String("string"),
    				AdditionalProperties: pulumi.String("string"),
    				TokenExpiryDate:      pulumi.String("string"),
    			},
    		},
    		IgnorePagination: pulumi.Bool(false),
    		NumWorkers:       pulumi.Float64(0),
    		PageSize:         pulumi.Float64(0),
    		StartDate:        pulumi.String("string"),
    	},
    	WorkspaceId:  pulumi.String("string"),
    	DefinitionId: pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	SecretId:     pulumi.String("string"),
    })
    
    var sourceZendeskSupportResource = new SourceZendeskSupport("sourceZendeskSupportResource", SourceZendeskSupportArgs.builder()
        .configuration(SourceZendeskSupportConfigurationArgs.builder()
            .subdomain("string")
            .additionalProperties("string")
            .credentials(SourceZendeskSupportConfigurationCredentialsArgs.builder()
                .apiToken(SourceZendeskSupportConfigurationCredentialsApiTokenArgs.builder()
                    .apiToken("string")
                    .email("string")
                    .additionalProperties("string")
                    .build())
                .oAuth20Legacy(SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs.builder()
                    .accessToken("string")
                    .additionalProperties("string")
                    .clientId("string")
                    .clientSecret("string")
                    .build())
                .oAuth20WithRefreshToken(SourceZendeskSupportConfigurationCredentialsOAuth20WithRefreshTokenArgs.builder()
                    .clientId("string")
                    .clientSecret("string")
                    .refreshToken("string")
                    .accessToken("string")
                    .additionalProperties("string")
                    .tokenExpiryDate("string")
                    .build())
                .build())
            .ignorePagination(false)
            .numWorkers(0.0)
            .pageSize(0.0)
            .startDate("string")
            .build())
        .workspaceId("string")
        .definitionId("string")
        .name("string")
        .secretId("string")
        .build());
    
    source_zendesk_support_resource = airbyte.SourceZendeskSupport("sourceZendeskSupportResource",
        configuration={
            "subdomain": "string",
            "additional_properties": "string",
            "credentials": {
                "api_token": {
                    "api_token": "string",
                    "email": "string",
                    "additional_properties": "string",
                },
                "o_auth20_legacy": {
                    "access_token": "string",
                    "additional_properties": "string",
                    "client_id": "string",
                    "client_secret": "string",
                },
                "o_auth20_with_refresh_token": {
                    "client_id": "string",
                    "client_secret": "string",
                    "refresh_token": "string",
                    "access_token": "string",
                    "additional_properties": "string",
                    "token_expiry_date": "string",
                },
            },
            "ignore_pagination": False,
            "num_workers": 0,
            "page_size": 0,
            "start_date": "string",
        },
        workspace_id="string",
        definition_id="string",
        name="string",
        secret_id="string")
    
    const sourceZendeskSupportResource = new airbyte.SourceZendeskSupport("sourceZendeskSupportResource", {
        configuration: {
            subdomain: "string",
            additionalProperties: "string",
            credentials: {
                apiToken: {
                    apiToken: "string",
                    email: "string",
                    additionalProperties: "string",
                },
                oAuth20Legacy: {
                    accessToken: "string",
                    additionalProperties: "string",
                    clientId: "string",
                    clientSecret: "string",
                },
                oAuth20WithRefreshToken: {
                    clientId: "string",
                    clientSecret: "string",
                    refreshToken: "string",
                    accessToken: "string",
                    additionalProperties: "string",
                    tokenExpiryDate: "string",
                },
            },
            ignorePagination: false,
            numWorkers: 0,
            pageSize: 0,
            startDate: "string",
        },
        workspaceId: "string",
        definitionId: "string",
        name: "string",
        secretId: "string",
    });
    
    type: airbyte:SourceZendeskSupport
    properties:
        configuration:
            additionalProperties: string
            credentials:
                apiToken:
                    additionalProperties: string
                    apiToken: string
                    email: string
                oAuth20Legacy:
                    accessToken: string
                    additionalProperties: string
                    clientId: string
                    clientSecret: string
                oAuth20WithRefreshToken:
                    accessToken: string
                    additionalProperties: string
                    clientId: string
                    clientSecret: string
                    refreshToken: string
                    tokenExpiryDate: string
            ignorePagination: false
            numWorkers: 0
            pageSize: 0
            startDate: string
            subdomain: string
        definitionId: string
        name: string
        secretId: string
        workspaceId: string
    

    SourceZendeskSupport 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 SourceZendeskSupport resource accepts the following input properties:

    Configuration SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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 SourceZendeskSupportConfigurationArgs
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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 SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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 SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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 SourceZendeskSupportConfigurationArgs
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; 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 SourceZendeskSupport resource produces the following output properties:

    CreatedAt double
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    SourceId string
    SourceType string
    CreatedAt float64
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    SourceId string
    SourceType string
    createdAt Double
    id String
    The provider-assigned unique ID for this managed resource.
    resourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    sourceId String
    sourceType String
    createdAt number
    id string
    The provider-assigned unique ID for this managed resource.
    resourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    sourceId string
    sourceType string
    created_at float
    id str
    The provider-assigned unique ID for this managed resource.
    resource_allocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    source_id str
    source_type str
    createdAt Number
    id String
    The provider-assigned unique ID for this managed resource.
    resourceAllocation Property Map
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    sourceId String
    sourceType String

    Look up Existing SourceZendeskSupport Resource

    Get an existing SourceZendeskSupport 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?: SourceZendeskSupportState, opts?: CustomResourceOptions): SourceZendeskSupport
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            configuration: Optional[SourceZendeskSupportConfigurationArgs] = None,
            created_at: Optional[float] = None,
            definition_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_allocation: Optional[SourceZendeskSupportResourceAllocationArgs] = None,
            secret_id: Optional[str] = None,
            source_id: Optional[str] = None,
            source_type: Optional[str] = None,
            workspace_id: Optional[str] = None) -> SourceZendeskSupport
    func GetSourceZendeskSupport(ctx *Context, name string, id IDInput, state *SourceZendeskSupportState, opts ...ResourceOption) (*SourceZendeskSupport, error)
    public static SourceZendeskSupport Get(string name, Input<string> id, SourceZendeskSupportState? state, CustomResourceOptions? opts = null)
    public static SourceZendeskSupport get(String name, Output<String> id, SourceZendeskSupportState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceZendeskSupport    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 SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    ResourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    Configuration SourceZendeskSupportConfigurationArgs
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    ResourceAllocation SourceZendeskSupportResourceAllocationArgs
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    configuration SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    resourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String
    configuration SourceZendeskSupportConfiguration
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    resourceAllocation SourceZendeskSupportResourceAllocation
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId string
    sourceType string
    workspaceId string
    configuration SourceZendeskSupportConfigurationArgs
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    resource_allocation SourceZendeskSupportResourceAllocationArgs
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    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
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "79c1aa37-dae3-42ae-b333-d1c105477715"; Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    resourceAllocation Property Map
    actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String

    Supporting Types

    SourceZendeskSupportConfiguration, SourceZendeskSupportConfigurationArgs

    Subdomain string
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    AdditionalProperties string
    Parsed as JSON.
    Credentials SourceZendeskSupportConfigurationCredentials
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    IgnorePagination bool
    [Deprecated] Makes each stream read a single page of data.
    NumWorkers double
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    PageSize double
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    StartDate string
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
    Subdomain string
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    AdditionalProperties string
    Parsed as JSON.
    Credentials SourceZendeskSupportConfigurationCredentials
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    IgnorePagination bool
    [Deprecated] Makes each stream read a single page of data.
    NumWorkers float64
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    PageSize float64
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    StartDate string
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
    subdomain String
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    additionalProperties String
    Parsed as JSON.
    credentials SourceZendeskSupportConfigurationCredentials
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    ignorePagination Boolean
    [Deprecated] Makes each stream read a single page of data.
    numWorkers Double
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    pageSize Double
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    startDate String
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
    subdomain string
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    additionalProperties string
    Parsed as JSON.
    credentials SourceZendeskSupportConfigurationCredentials
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    ignorePagination boolean
    [Deprecated] Makes each stream read a single page of data.
    numWorkers number
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    pageSize number
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    startDate string
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
    subdomain str
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    additional_properties str
    Parsed as JSON.
    credentials SourceZendeskSupportConfigurationCredentials
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    ignore_pagination bool
    [Deprecated] Makes each stream read a single page of data.
    num_workers float
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    page_size float
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    start_date str
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
    subdomain String
    This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MYSUBDOMAIN.zendesk.com/, MYSUBDOMAIN is the value of your subdomain.
    additionalProperties String
    Parsed as JSON.
    credentials Property Map
    Zendesk allows three authentication methods. We recommend using OAuth2.0 with Refresh Token for Airbyte Cloud users (recommended), OAuth2.0 (Legacy) for existing OAuth connections, and API token for Airbyte Open Source users.
    ignorePagination Boolean
    [Deprecated] Makes each stream read a single page of data.
    numWorkers Number
    The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Zendesk Support plan. More info about the rate limit plan tiers can be found on Zendesk's API \n\ndocs\n\n. Default: 3
    pageSize Number
    The number of records per page for the ticket_comments stream API requests. Lower values may help prevent timeouts on large datasets. The maximum value is 1000. Default: 100
    startDate String
    The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.

    SourceZendeskSupportConfigurationCredentials, SourceZendeskSupportConfigurationCredentialsArgs

    SourceZendeskSupportConfigurationCredentialsApiToken, SourceZendeskSupportConfigurationCredentialsApiTokenArgs

    ApiToken string
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    Email string
    The user email for your Zendesk account.
    AdditionalProperties string
    Parsed as JSON.
    ApiToken string
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    Email string
    The user email for your Zendesk account.
    AdditionalProperties string
    Parsed as JSON.
    apiToken String
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    email String
    The user email for your Zendesk account.
    additionalProperties String
    Parsed as JSON.
    apiToken string
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    email string
    The user email for your Zendesk account.
    additionalProperties string
    Parsed as JSON.
    api_token str
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    email str
    The user email for your Zendesk account.
    additional_properties str
    Parsed as JSON.
    apiToken String
    The value of the API token generated. See our \n\nfull documentation\n\n for more information on generating this token.
    email String
    The user email for your Zendesk account.
    additionalProperties String
    Parsed as JSON.

    SourceZendeskSupportConfigurationCredentialsOAuth20Legacy, SourceZendeskSupportConfigurationCredentialsOAuth20LegacyArgs

    AccessToken string
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    AdditionalProperties string
    Parsed as JSON.
    ClientId string
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    ClientSecret string
    The OAuth client secret. See \n\nthis guide\n\n for more information.
    AccessToken string
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    AdditionalProperties string
    Parsed as JSON.
    ClientId string
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    ClientSecret string
    The OAuth client secret. See \n\nthis guide\n\n for more information.
    accessToken String
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    additionalProperties String
    Parsed as JSON.
    clientId String
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    clientSecret String
    The OAuth client secret. See \n\nthis guide\n\n for more information.
    accessToken string
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    additionalProperties string
    Parsed as JSON.
    clientId string
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    clientSecret string
    The OAuth client secret. See \n\nthis guide\n\n for more information.
    access_token str
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    additional_properties str
    Parsed as JSON.
    client_id str
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    client_secret str
    The OAuth client secret. See \n\nthis guide\n\n for more information.
    accessToken String
    The OAuth access token. See the \n\nZendesk docs\n\n for more information on generating this token.
    additionalProperties String
    Parsed as JSON.
    clientId String
    The OAuth client's ID. See \n\nthis guide\n\n for more information.
    clientSecret String
    The OAuth client secret. See \n\nthis guide\n\n for more information.

    SourceZendeskSupportConfigurationCredentialsOAuth20WithRefreshToken, SourceZendeskSupportConfigurationCredentialsOAuth20WithRefreshTokenArgs

    ClientId string
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    ClientSecret string
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    RefreshToken string
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    AccessToken string
    Access Token for making authenticated requests.
    AdditionalProperties string
    Parsed as JSON.
    TokenExpiryDate string
    The date-time when the access token should be refreshed.
    ClientId string
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    ClientSecret string
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    RefreshToken string
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    AccessToken string
    Access Token for making authenticated requests.
    AdditionalProperties string
    Parsed as JSON.
    TokenExpiryDate string
    The date-time when the access token should be refreshed.
    clientId String
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    clientSecret String
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    refreshToken String
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    accessToken String
    Access Token for making authenticated requests.
    additionalProperties String
    Parsed as JSON.
    tokenExpiryDate String
    The date-time when the access token should be refreshed.
    clientId string
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    clientSecret string
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    refreshToken string
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    accessToken string
    Access Token for making authenticated requests.
    additionalProperties string
    Parsed as JSON.
    tokenExpiryDate string
    The date-time when the access token should be refreshed.
    client_id str
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    client_secret str
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    refresh_token str
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    access_token str
    Access Token for making authenticated requests.
    additional_properties str
    Parsed as JSON.
    token_expiry_date str
    The date-time when the access token should be refreshed.
    clientId String
    The OAuth client's ID. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    clientSecret String
    The OAuth client secret. See \n\nZendesk OAuth grant-type tokens documentation\n\n for more information.
    refreshToken String
    The refresh token used to obtain new access tokens. Note that Zendesk uses rotating refresh tokens - each refresh will return a new refresh token and invalidate the previous one.
    accessToken String
    Access Token for making authenticated requests.
    additionalProperties String
    Parsed as JSON.
    tokenExpiryDate String
    The date-time when the access token should be refreshed.

    SourceZendeskSupportResourceAllocation, SourceZendeskSupportResourceAllocationArgs

    Default SourceZendeskSupportResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics List<SourceZendeskSupportResourceAllocationJobSpecific>
    Default SourceZendeskSupportResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics []SourceZendeskSupportResourceAllocationJobSpecific
    default_ SourceZendeskSupportResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics List<SourceZendeskSupportResourceAllocationJobSpecific>
    default SourceZendeskSupportResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics SourceZendeskSupportResourceAllocationJobSpecific[]
    default Property Map
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics List<Property Map>

    SourceZendeskSupportResourceAllocationDefault, SourceZendeskSupportResourceAllocationDefaultArgs

    SourceZendeskSupportResourceAllocationJobSpecific, SourceZendeskSupportResourceAllocationJobSpecificArgs

    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType string
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    job_type str
    enum that describes the different types of jobs that the platform runs.
    resource_requirements SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements Property Map
    optional resource requirements to run workers (blank for unbounded allocations)

    SourceZendeskSupportResourceAllocationJobSpecificResourceRequirements, SourceZendeskSupportResourceAllocationJobSpecificResourceRequirementsArgs

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = airbyte_source_zendesk_support.my_airbyte_source_zendesk_support

    id = “…”

    }

    The pulumi import command can be used, for example:

    $ pulumi import airbyte:index/sourceZendeskSupport:SourceZendeskSupport my_airbyte_source_zendesk_support "..."
    

    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
    Viewing docs for airbyte 1.0.0
    published on Wednesday, Mar 4, 2026 by airbytehq
      Try Pulumi Cloud free. Your team will thank you.