0
# Configuration
1

2
Connection configuration and authentication setup for the Zendesk Chat source connector.
3

4
## Capabilities
5

6
### Connection Specification
7

8
Complete JSON schema for connector configuration as defined in the manifest specification.
9

10
```json { .api }
11
{
12
  "type": "object",
13
  "$schema": "http://json-schema.org/draft-07/schema#",
14
  "required": ["start_date", "subdomain"],
15
  "properties": {
16
    "start_date": {
17
      "type": "string",
18
      "description": "The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.",
19
      "title": "Start Date",
20
      "examples": ["2021-02-01T00:00:00Z"],
21
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
22
      "format": "date-time",
23
      "order": 0
24
    },
25
    "subdomain": {
26
      "type": "string",
27
      "description": "The unique subdomain of your Zendesk account (without https://)",
28
      "title": "Subdomain", 
29
      "order": 1,
30
      "pattern": "^(?!https://)",
31
      "examples": ["myzendeskchat"]
32
    },
33
    "credentials": {
34
      "type": "object",
35
      "title": "Authorization Method",
36
      "oneOf": [
37
        {"$ref": "#/oauth2_credentials"},
38
        {"$ref": "#/access_token_credentials"}
39
      ],
40
      "order": 2
41
    }
42
  },
43
  "additionalProperties": true
44
}
45
```
46

47
### Required Configuration Fields
48

49
Essential parameters that must be provided for connector operation.
50

51
```json { .api }
52
{
53
  "start_date": {
54
    "type": "string",
55
    "required": true,
56
    "format": "date-time",
57
    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
58
    "description": "Date from which to replicate data (YYYY-MM-DDTHH:MM:SSZ)",
59
    "example": "2021-01-01T00:00:00Z"
60
  },
61
  "subdomain": {
62
    "type": "string",
63
    "required": true,
64
    "pattern": "^(?!https://)",
65
    "description": "Zendesk account subdomain without https://",
66
    "example": "mycompany"
67
  }
68
}
69
```
70

71
### OAuth2 Authentication
72

73
OAuth2.0 authentication configuration schema for secure API access.
74

75
```json { .api }
76
{
77
  "type": "object",
78
  "title": "OAuth2.0",
79
  "required": ["credentials"],
80
  "properties": {
81
    "credentials": {
82
      "type": "string",
83
      "const": "oauth2.0",
84
      "order": 0
85
    },
86
    "client_id": {
87
      "type": "string",
88
      "description": "The Client ID of your OAuth application",
89
      "title": "Client ID",
90
      "airbyte_secret": true
91
    },
92
    "client_secret": {
93
      "type": "string", 
94
      "description": "The Client Secret of your OAuth application",
95
      "title": "Client Secret",
96
      "airbyte_secret": true
97
    },
98
    "access_token": {
99
      "type": "string",
100
      "description": "Access Token for making authenticated requests",
101
      "title": "Access Token", 
102
      "airbyte_secret": true
103
    },
104
    "refresh_token": {
105
      "type": "string",
106
      "description": "Refresh Token to obtain new Access Token, when it's expired",
107
      "title": "Refresh Token",
108
      "airbyte_secret": true
109
    }
110
  }
111
}
112
```
113

114
### Access Token Authentication
115

116
Direct access token authentication configuration schema for simplified setup.
117

118
```json { .api }
119
{
120
  "type": "object",
121
  "title": "Access Token",
122
  "required": ["credentials", "access_token"],
123
  "properties": {
124
    "credentials": {
125
      "type": "string",
126
      "const": "access_token",
127
      "order": 0
128
    },
129
    "access_token": {
130
      "type": "string",
131
      "description": "The Access Token to make authenticated requests",
132
      "title": "Access Token",
133
      "airbyte_secret": true
134
    }
135
  }
136
}
137
```
138

139
### Configuration Examples
140

141
```json
142
// OAuth2 Configuration
143
{
144
  "start_date": "2021-01-01T00:00:00Z",
145
  "subdomain": "mycompany", 
146
  "credentials": {
147
    "credentials": "oauth2.0",
148
    "client_id": "your_client_id",
149
    "client_secret": "your_client_secret", 
150
    "access_token": "your_access_token",
151
    "refresh_token": "your_refresh_token"
152
  }
153
}
154

155
// Access Token Configuration  
156
{
157
  "start_date": "2021-01-01T00:00:00Z",
158
  "subdomain": "mycompany",
159
  "credentials": {
160
    "credentials": "access_token",
161
    "access_token": "your_access_token"
162
  }
163
}
164
```
165

166
## Types
167

168
```json { .api }
169
{
170
  "ConfigurationObject": {
171
    "type": "object",
172
    "description": "Complete connector configuration structure",
173
    "properties": {
174
      "start_date": {"type": "string", "format": "date-time"},
175
      "subdomain": {"type": "string"},
176
      "credentials": {"$ref": "#/CredentialsUnion"}
177
    }
178
  },
179
  "CredentialsUnion": {
180
    "oneOf": [
181
      {"$ref": "#/OAuth2Credentials"},
182
      {"$ref": "#/AccessTokenCredentials"}
183
    ],
184
    "description": "Union type for all supported authentication methods"
185
  },
186
  "AuthMethod": {
187
    "enum": ["oauth2.0", "access_token"],
188
    "description": "Available authentication method identifiers"
189
  }
190
}
191
```