Skip to content

Commit 8ef69a9

Browse files
docs: sync agent connector docs from airbyte-agent-connectors repo (#75525)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
1 parent 62609cd commit 8ef69a9

File tree

2 files changed

+52
-13
lines changed

2 files changed

+52
-13
lines changed

docs/ai-agents/connectors/hubspot/AUTH.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Example request:
2424

2525
```python
2626
from airbyte_agent_hubspot import HubspotConnector
27-
from airbyte_agent_hubspot.models import HubspotAuthConfig
27+
from airbyte_agent_hubspot.models import HubspotOauth2AuthConfig
2828

2929
connector = HubspotConnector(
30-
auth_config=HubspotAuthConfig(
30+
auth_config=HubspotOauth2AuthConfig(
3131
client_id="<Your HubSpot OAuth2 Client ID>",
3232
client_secret="<Your HubSpot OAuth2 Client Secret>",
3333
refresh_token="<Your HubSpot OAuth2 Refresh Token>",
@@ -37,7 +37,25 @@ connector = HubspotConnector(
3737
```
3838

3939
#### Token
40-
This authentication method isn't available for this connector.
40+
41+
`credentials` fields you need:
42+
43+
| Field Name | Type | Required | Description |
44+
|------------|------|----------|-------------|
45+
| `private_app_token` | `str` | Yes | Access token from a HubSpot Private App |
46+
47+
Example request:
48+
49+
```python
50+
from airbyte_agent_hubspot import HubspotConnector
51+
from airbyte_agent_hubspot.models import HubspotPrivateAppAuthConfig
52+
53+
connector = HubspotConnector(
54+
auth_config=HubspotPrivateAppAuthConfig(
55+
private_app_token="<Access token from a HubSpot Private App>"
56+
)
57+
)
58+
```
4159

4260
### Hosted execution
4361

@@ -174,7 +192,31 @@ https://yourapp.com/oauth/callback?connector_id=<connector_id>
174192
Extract the `connector_id` from the callback URL and store it for future operations. For error handling and a complete implementation example, see [Build your own OAuth flow](https://docs.airbyte.com/ai-agents/platform/authenticate/build-auth/build-your-own#part-3-handle-the-callback).
175193

176194
#### Token
177-
This authentication method isn't available for this connector.
195+
Create a connector with Token credentials.
196+
197+
198+
`credentials` fields you need:
199+
200+
| Field Name | Type | Required | Description |
201+
|------------|------|----------|-------------|
202+
| `private_app_token` | `str` | Yes | Access token from a HubSpot Private App |
203+
204+
Example request:
205+
206+
207+
```bash
208+
curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
209+
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
210+
-H "Content-Type: application/json" \
211+
-d '{
212+
"customer_name": "<CUSTOMER_NAME>",
213+
"connector_type": "Hubspot",
214+
"name": "My Hubspot Connector",
215+
"credentials": {
216+
"private_app_token": "<Access token from a HubSpot Private App>"
217+
}
218+
}'
219+
```
178220

179221
#### Execution
180222

docs/ai-agents/connectors/hubspot/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,11 @@ In open source mode, you provide API credentials directly to the connector.
4949

5050
```python
5151
from airbyte_agent_hubspot import HubspotConnector
52-
from airbyte_agent_hubspot.models import HubspotAuthConfig
52+
from airbyte_agent_hubspot.models import HubspotPrivateAppAuthConfig
5353

5454
connector = HubspotConnector(
55-
auth_config=HubspotAuthConfig(
56-
client_id="<Your HubSpot OAuth2 Client ID>",
57-
client_secret="<Your HubSpot OAuth2 Client Secret>",
58-
refresh_token="<Your HubSpot OAuth2 Refresh Token>",
59-
access_token="<Your HubSpot OAuth2 Access Token (optional if refresh_token is provided)>"
55+
auth_config=HubspotPrivateAppAuthConfig(
56+
private_app_token="<Access token from a HubSpot Private App>"
6057
)
6158
)
6259

@@ -117,7 +114,7 @@ See the official [Hubspot API reference](https://developers.hubspot.com/docs/api
117114

118115
## Version information
119116

120-
- **Package version:** 0.15.124
121-
- **Connector version:** 0.1.14
122-
- **Generated with Connector SDK commit SHA:** 75f388847745be753ab20224c66697e1d4a84347
117+
- **Package version:** 0.15.125
118+
- **Connector version:** 0.1.15
119+
- **Generated with Connector SDK commit SHA:** 547c701420fd178a856f06b58309e9ac6c78f310
123120
- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/hubspot/CHANGELOG.md)

0 commit comments

Comments
 (0)