Skip to content

Latest commit

 

History

History
189 lines (131 loc) · 8.98 KB

source_zendesk_support.md

File metadata and controls

189 lines (131 loc) · 8.98 KB
page_title subcategory description
airbyte_source_zendesk_support Resource - terraform-provider-airbyte
SourceZendeskSupport Resource

airbyte_source_zendesk_support (Resource)

SourceZendeskSupport Resource

Example Usage

resource "airbyte_source_zendesk_support" "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"
}

Schema

Required

  • configuration (Attributes) The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. (see below for nested schema)
  • name (String) Name of the source e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (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.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • resource_allocation (Attributes) 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. (see below for nested schema)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • subdomain (String) This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is the value of your subdomain.

Optional:

  • additional_properties (String) Parsed as JSON.
  • credentials (Attributes) 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. (see below for nested schema)
  • ignore_pagination (Boolean) [Deprecated] Makes each stream read a single page of data.
  • num_workers (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 docs. Default: 3
  • page_size (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
  • start_date (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.

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_token

Required:

  • api_token (String, Sensitive) The value of the API token generated. See our full documentation for more information on generating this token.
  • email (String) The user email for your Zendesk account.

Optional:

  • additional_properties (String) Parsed as JSON.

Nested Schema for configuration.credentials.o_auth20_legacy

Required:

  • access_token (String, Sensitive) The OAuth access token. See the Zendesk docs for more information on generating this token.

Optional:

  • additional_properties (String) Parsed as JSON.
  • client_id (String, Sensitive) The OAuth client's ID. See this guide for more information.
  • client_secret (String, Sensitive) The OAuth client secret. See this guide for more information.

Nested Schema for configuration.credentials.o_auth20_with_refresh_token

Required:

  • client_id (String, Sensitive) The OAuth client's ID. See Zendesk OAuth grant-type tokens documentation for more information.
  • client_secret (String, Sensitive) The OAuth client secret. See Zendesk OAuth grant-type tokens documentation for more information.
  • refresh_token (String, Sensitive) 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.

Optional:

  • access_token (String, Sensitive) Access Token for making authenticated requests.
  • additional_properties (String) Parsed as JSON.
  • token_expiry_date (String) The date-time when the access token should be refreshed.

Nested Schema for resource_allocation

Read-Only:

Nested Schema for resource_allocation.default

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Nested Schema for resource_allocation.job_specific

Read-Only:

  • job_type (String) enum that describes the different types of jobs that the platform runs.
  • resource_requirements (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see below for nested schema)

Nested Schema for resource_allocation.job_specific.resource_requirements

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Import

Import is supported using the following syntax:

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

import {
  to = airbyte_source_zendesk_support.my_airbyte_source_zendesk_support
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_zendesk_support.my_airbyte_source_zendesk_support "..."