Skip to content

Commit 0bace10

Browse files
authored
Create readme.md
1 parent 29a1497 commit 0bace10

File tree

1 file changed

+55
-0
lines changed
  • src/Umbraco.Cms.Integrations.Crm.ActiveCampaign

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Umbraco.Cms.Integrations.Crm.ActiveCampaign
2+
3+
This integration provides a form picker and rendering component for forms managed withing a Microsoft Dynamics 365 Marketing instance.
4+
5+
## Prerequisites
6+
7+
Required minimum versions of Umbraco CMS:
8+
- 10.1.0
9+
10+
## How To Use
11+
12+
### Authentication
13+
14+
All requests to the ActiveCampaign API are authenticated by providing
15+
an API key. The API key is included as an HTTP header called _Api_Token_
16+
17+
### Configuration
18+
19+
To connect to your ActiveCampaign account, the following configuration is required:
20+
```
21+
"Umbraco": {
22+
"CMS": {
23+
"Integrations": {
24+
"Crm": {
25+
"ActiveCampaign": {
26+
"Settings": {
27+
"BaseUrl": "https://[YOUR_ACCOUNT_NAME].api-us1.com",
28+
"ApiKey": "[YOUR_API_KEY]"
29+
}
30+
}
31+
}
32+
}
33+
```
34+
35+
### Backoffice usage
36+
37+
To use the form picker, a new data type should be created based on the ActiveCampaign Form Picker property editor.
38+
39+
The settings in `appsettings.json` will be used for sending the required HTTP header for authorization, and for retrieving the account name used for rendering the form.
40+
41+
### Front-end rendering
42+
43+
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.
44+
45+
Ensure your template has a reference to the following using statement:
46+
47+
```
48+
@using Umbraco.Cms.Integrations.Crm.ActiveCampaign.Helpers;
49+
```
50+
51+
And render the form using (assuming a property based on the created data type, with alias `activeCampaignForm` has been created):
52+
53+
```
54+
@Html.RenderActiveCampaignForm(Model.ActiveCampaignForm)
55+
```

0 commit comments

Comments
 (0)