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

airbyte.SourceZendeskChat

Explore with Pulumi AI

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

    SourceZendeskChat 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.SourceZendeskChat;
import com.pulumi.airbyte.SourceZendeskChatArgs;
import com.pulumi.airbyte.inputs.SourceZendeskChatConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceZendeskChatConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceZendeskChatConfigurationCredentialsAccessTokenArgs;
import com.pulumi.airbyte.inputs.SourceZendeskChatConfigurationCredentialsOAuth20Args;
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 mySourceZendeskchat = new SourceZendeskChat("mySourceZendeskchat", SourceZendeskChatArgs.builder()
            .configuration(SourceZendeskChatConfigurationArgs.builder()
                .credentials(SourceZendeskChatConfigurationCredentialsArgs.builder()
                    .accessToken(SourceZendeskChatConfigurationCredentialsAccessTokenArgs.builder()
                        .accessToken("...my_access_token...")
                        .build())
                    .oAuth20(SourceZendeskChatConfigurationCredentialsOAuth20Args.builder()
                        .accessToken("...my_access_token...")
                        .clientId("...my_client_id...")
                        .clientSecret("...my_client_secret...")
                        .refreshToken("...my_refresh_token...")
                        .build())
                    .build())
                .start_date("2021-02-01T00:00:00Z")
                .subdomain("myzendeskchat")
                .build())
            .definitionId("0e292d86-9483-43d3-8271-797f9030e946")
            .secretId("...my_secret_id...")
            .workspaceId("163f1f29-3c8c-43af-8d79-98eebba4d690")
            .build());

    }
}

    resources:
  mySourceZendeskchat:
    type: airbyte:SourceZendeskChat
    properties:
      configuration:
        credentials:
          accessToken:
            accessToken: '...my_access_token...'
          oAuth20:
            accessToken: '...my_access_token...'
            clientId: '...my_client_id...'
            clientSecret: '...my_client_secret...'
            refreshToken: '...my_refresh_token...'
        start_date: 2021-02-01T00:00:00Z
        subdomain: myzendeskchat
      definitionId: 0e292d86-9483-43d3-8271-797f9030e946
      secretId: '...my_secret_id...'
      workspaceId: 163f1f29-3c8c-43af-8d79-98eebba4d690

    Create SourceZendeskChat Resource

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

    Constructor syntax

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

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

    type: airbyte:SourceZendeskChat
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 SourceZendeskChatArgs
    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 SourceZendeskChatArgs
    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 SourceZendeskChatArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceZendeskChatArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceZendeskChatArgs
    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 sourceZendeskChatResource = new Airbyte.SourceZendeskChat("sourceZendeskChatResource", new()
{
    Configuration = new Airbyte.Inputs.SourceZendeskChatConfigurationArgs
    {
        StartDate = "string",
        Credentials = new Airbyte.Inputs.SourceZendeskChatConfigurationCredentialsArgs
        {
            AccessToken = new Airbyte.Inputs.SourceZendeskChatConfigurationCredentialsAccessTokenArgs
            {
                AccessToken = "string",
            },
            OAuth20 = new Airbyte.Inputs.SourceZendeskChatConfigurationCredentialsOAuth20Args
            {
                AccessToken = "string",
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
            },
        },
        Subdomain = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceZendeskChat(ctx, "sourceZendeskChatResource", &airbyte.SourceZendeskChatArgs{
Configuration: &.SourceZendeskChatConfigurationArgs{
StartDate: pulumi.String("string"),
Credentials: &.SourceZendeskChatConfigurationCredentialsArgs{
AccessToken: &.SourceZendeskChatConfigurationCredentialsAccessTokenArgs{
AccessToken: pulumi.String("string"),
},
OAuth20: &.SourceZendeskChatConfigurationCredentialsOAuth20Args{
AccessToken: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
},
},
Subdomain: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceZendeskChatResource = new SourceZendeskChat("sourceZendeskChatResource", SourceZendeskChatArgs.builder()
    .configuration(SourceZendeskChatConfigurationArgs.builder()
        .startDate("string")
        .credentials(SourceZendeskChatConfigurationCredentialsArgs.builder()
            .accessToken(SourceZendeskChatConfigurationCredentialsAccessTokenArgs.builder()
                .accessToken("string")
                .build())
            .oAuth20(SourceZendeskChatConfigurationCredentialsOAuth20Args.builder()
                .accessToken("string")
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .build())
            .build())
        .subdomain("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_zendesk_chat_resource = airbyte.SourceZendeskChat("sourceZendeskChatResource",
    configuration={
        "start_date": "string",
        "credentials": {
            "access_token": {
                "access_token": "string",
            },
            "o_auth20": {
                "access_token": "string",
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
            },
        },
        "subdomain": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceZendeskChatResource = new airbyte.SourceZendeskChat("sourceZendeskChatResource", {
    configuration: {
        startDate: "string",
        credentials: {
            accessToken: {
                accessToken: "string",
            },
            oAuth20: {
                accessToken: "string",
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
            },
        },
        subdomain: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceZendeskChat
properties:
    configuration:
        credentials:
            accessToken:
                accessToken: string
            oAuth20:
                accessToken: string
                clientId: string
                clientSecret: string
                refreshToken: string
        startDate: string
        subdomain: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceZendeskChatConfiguration
    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 SourceZendeskChatConfigurationArgs
    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 SourceZendeskChatConfiguration
    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 SourceZendeskChatConfiguration
    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 SourceZendeskChatConfigurationArgs
    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 SourceZendeskChat 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 SourceZendeskChat Resource

    Get an existing SourceZendeskChat 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?: SourceZendeskChatState, opts?: CustomResourceOptions): SourceZendeskChat
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceZendeskChatConfigurationArgs] = 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) -> SourceZendeskChat
    func GetSourceZendeskChat(ctx *Context, name string, id IDInput, state *SourceZendeskChatState, opts ...ResourceOption) (*SourceZendeskChat, error)
    public static SourceZendeskChat Get(string name, Input<string> id, SourceZendeskChatState? state, CustomResourceOptions? opts = null)
    public static SourceZendeskChat get(String name, Output<String> id, SourceZendeskChatState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceZendeskChat    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 SourceZendeskChatConfiguration
    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 SourceZendeskChatConfigurationArgs
    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 SourceZendeskChatConfiguration
    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 SourceZendeskChatConfiguration
    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 SourceZendeskChatConfigurationArgs
    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

    SourceZendeskChatConfiguration, SourceZendeskChatConfigurationArgs

    StartDate string
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    Credentials SourceZendeskChatConfigurationCredentials
    Subdomain string
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""
    StartDate string
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    Credentials SourceZendeskChatConfigurationCredentials
    Subdomain string
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""
    startDate String
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    credentials SourceZendeskChatConfigurationCredentials
    subdomain String
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""
    startDate string
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    credentials SourceZendeskChatConfigurationCredentials
    subdomain string
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""
    start_date str
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    credentials SourceZendeskChatConfigurationCredentials
    subdomain str
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""
    startDate String
    The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.
    credentials Property Map
    subdomain String
    The unique subdomain of your Zendesk account (without https://). \n\nSee the Zendesk docs to find your subdomain\n\n. Default: ""

    SourceZendeskChatConfigurationCredentials, SourceZendeskChatConfigurationCredentialsArgs

    SourceZendeskChatConfigurationCredentialsAccessToken, SourceZendeskChatConfigurationCredentialsAccessTokenArgs

    AccessToken string
    The Access Token to make authenticated requests.
    AccessToken string
    The Access Token to make authenticated requests.
    accessToken String
    The Access Token to make authenticated requests.
    accessToken string
    The Access Token to make authenticated requests.
    access_token str
    The Access Token to make authenticated requests.
    accessToken String
    The Access Token to make authenticated requests.

    SourceZendeskChatConfigurationCredentialsOAuth20, SourceZendeskChatConfigurationCredentialsOAuth20Args

    AccessToken string
    Access Token for making authenticated requests.
    ClientId string
    The Client ID of your OAuth application
    ClientSecret string
    The Client Secret of your OAuth application.
    RefreshToken string
    Refresh Token to obtain new Access Token, when it's expired.
    AccessToken string
    Access Token for making authenticated requests.
    ClientId string
    The Client ID of your OAuth application
    ClientSecret string
    The Client Secret of your OAuth application.
    RefreshToken string
    Refresh Token to obtain new Access Token, when it's expired.
    accessToken String
    Access Token for making authenticated requests.
    clientId String
    The Client ID of your OAuth application
    clientSecret String
    The Client Secret of your OAuth application.
    refreshToken String
    Refresh Token to obtain new Access Token, when it's expired.
    accessToken string
    Access Token for making authenticated requests.
    clientId string
    The Client ID of your OAuth application
    clientSecret string
    The Client Secret of your OAuth application.
    refreshToken string
    Refresh Token to obtain new Access Token, when it's expired.
    access_token str
    Access Token for making authenticated requests.
    client_id str
    The Client ID of your OAuth application
    client_secret str
    The Client Secret of your OAuth application.
    refresh_token str
    Refresh Token to obtain new Access Token, when it's expired.
    accessToken String
    Access Token for making authenticated requests.
    clientId String
    The Client ID of your OAuth application
    clientSecret String
    The Client Secret of your OAuth application.
    refreshToken String
    Refresh Token to obtain new Access Token, when it's expired.

    Import

    $ pulumi import airbyte:index/sourceZendeskChat:SourceZendeskChat my_airbyte_source_zendesk_chat ""

    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