-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
spec.yaml
131 lines (131 loc) · 4.45 KB
/
spec.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
documentationUrl: https://docs.airbyte.com/integrations/sources/hubspot
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: HubSpot Source Spec
type: object
required:
- credentials
additionalProperties: true
properties:
start_date:
type: string
title: Start date
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
description: >-
UTC date and time in the format 2017-01-25T00:00:00Z. Any data before
this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date.
It's recommended to provide relevant to your data start date value to optimize synchronization.
examples:
- "2017-01-25T00:00:00Z"
format: date-time
credentials:
title: Authentication
description: Choose how to authenticate to HubSpot.
type: object
oneOf:
- type: object
title: OAuth
required:
- client_id
- client_secret
- refresh_token
- credentials_title
properties:
credentials_title:
type: string
title: Auth Type
description: Name of the credentials
const: OAuth Credentials
order: 0
client_id:
title: Client ID
description: >-
The Client ID of your HubSpot developer application. See the <a
href="https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart">Hubspot docs</a>
if you need help finding this ID.
type: string
examples:
- "123456789000"
client_secret:
title: Client Secret
description: >-
The client secret for your HubSpot developer application. See the <a
href="https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart">Hubspot docs</a>
if you need help finding this secret.
type: string
examples:
- secret
airbyte_secret: true
refresh_token:
title: Refresh Token
description: >-
Refresh token to renew an expired access token. See the <a
href="https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart">Hubspot docs</a>
if you need help finding this token.
type: string
examples:
- refresh_token
airbyte_secret: true
- type: object
title: Private App
required:
- access_token
- credentials_title
properties:
credentials_title:
type: string
title: Auth Type
description: Name of the credentials set
const: Private App Credentials
order: 0
access_token:
title: Access token
description: >-
HubSpot Access token. See the <a
href="https://developers.hubspot.com/docs/api/private-apps">Hubspot docs</a>
if you need help finding this token.
type: string
airbyte_secret: true
enable_experimental_streams:
title: Enable experimental streams
description: If enabled then experimental streams become available for sync.
type: boolean
default: false
advanced_auth:
auth_flow_type: oauth2.0
predicate_key:
- credentials
- credentials_title
predicate_value: OAuth Credentials
oauth_config_specification:
complete_oauth_output_specification:
type: object
additionalProperties: false
properties:
refresh_token:
type: string
path_in_connector_config:
- credentials
- refresh_token
complete_oauth_server_input_specification:
type: object
additionalProperties: false
properties:
client_id:
type: string
client_secret:
type: string
complete_oauth_server_output_specification:
type: object
additionalProperties: false
properties:
client_id:
type: string
path_in_connector_config:
- credentials
- client_id
client_secret:
type: string
path_in_connector_config:
- credentials
- client_secret