Skip to content

Commit 2ce7ca6

Browse files
authored
Update readme.md
1 parent 3e86c41 commit 2ce7ca6

File tree

1 file changed

+23
-3
lines changed
  • src/Umbraco.Cms.Integrations.Crm.Hubspot

1 file changed

+23
-3
lines changed

src/Umbraco.Cms.Integrations.Crm.Hubspot/readme.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,44 @@ Required minimum versions of Umbraco CMS:
1414

1515
### Authentication
1616

17-
The package uses the OAuth protocol for authentication.
17+
The package uses the OAuth protocol for authentication or private access tokens (if you are using a private app installed on your HubSpot account).
1818

1919
### Additional Configuration
2020

21-
To support multi-region HubSpot forms, the following app setting is required in `Web.config`:
21+
To support multi-region HubSpot forms, the following app settings are required:
22+
- Umbraco 8 `web.config`:
2223
```
2324
<appSettings>
2425
...
26+
<add key="Umbraco.Cms.Integrations.Crm.Hubspot.ApiKey" value="[your_private_app_access_token]" />
2527
<add key="Umbraco.Cms.Integrations.Crm.Hubspot.Region" value="[region]" />
2628
...
2729
</appSettings>
2830
```
31+
- Umbraco 9+ `appsettings.json`:
32+
```
33+
"Integrations": {
34+
"Crm": {
35+
"Dynamics": {
36+
"Settings": {
37+
"ApiKey": "[your_private_app_access_token]",
38+
"Region": "[region]"
39+
}
40+
}
41+
}
42+
}
43+
```
2944

3045
For example, in Europe, a setting of `eu1` should be used.
3146

3247
### Backoffice usage
3348

49+
#### Note:
50+
**As of November 30, 2022, HubSpot API is accessible using a private app access token or OAuth.**
51+
3452
To use the form picker, a new data type should be created based on the HubSpot Form Picker property editor.
3553

36-
The settings in `Web.config` will be checked and a message presented indicating whether authenticiation is in place.
54+
The settings will be checked and a message presented indicating whether authenticiation is in place.
3755

3856
If OAuth is being used for authentication is available, then the _Connect_ button will be enabled, prompting the user when clicked,
3957
with the HubSpot authorization window.
@@ -42,6 +60,8 @@ The retrieved access token will be saved into the database and used for future r
4260

4361
_Revoke_ action will remove the access token from the database and the authorization process will need to be repeated.
4462

63+
If a private access token is used a message will be displayed notifying that access token is being used.
64+
4565
### Front-end rendering
4666

4767
A strongly typed model will be generated by the property value converter, and an HTML helper is available, to easily render the form on the front-end.

0 commit comments

Comments
 (0)