|
| 1 | +# Umbraco.Cms.Integrations.Automation.Zapier |
| 2 | + |
| 3 | +This integration provides a dashboard interface that allows users to map content types with Zap triggers webhooks. |
| 4 | + |
| 5 | +When the content type gets published, the details of the configuration are looked up into the database and if a record is found, |
| 6 | +will send a request to the Zap, triggering the matching actions. |
| 7 | + |
| 8 | +A Zap is an automated workflow that connects various apps and services together. Each Zap consists of a trigger and one or more actions. |
| 9 | + |
| 10 | +## Prerequisites |
| 11 | + |
| 12 | +Requires minimum versions of Umbraco: |
| 13 | + |
| 14 | +- CMS V8: 8.5.4 |
| 15 | +- CMS V9: 9.0.1 |
| 16 | + |
| 17 | +## How To Use |
| 18 | + |
| 19 | +### Authentication |
| 20 | + |
| 21 | +For this integration, the authentication is managed on Zapier's side. |
| 22 | + |
| 23 | +When creating a Zap trigger, you will be prompted to enter a username, password and the URL for your Umbraco website. |
| 24 | + |
| 25 | +Then the Umbraco application existing in the Zapier marketplace will validate the credentials entered and return a message in case the validation fails. |
| 26 | + |
| 27 | +If you want to extend the security layer, you can also specify a user group that the user trying to connect needs to be a part of, by adding the following |
| 28 | +setting in `Web.config`: |
| 29 | + |
| 30 | +``` |
| 31 | +<appSettings> |
| 32 | +... |
| 33 | + <add key="Umbraco.Cms.Integrations.Automation.Zapier.UserGroup" value="[your User Group]" /> |
| 34 | +... |
| 35 | +</appSettings> |
| 36 | +``` |
| 37 | + |
| 38 | +### Working With the Zapier Cms Integration |
| 39 | +In the _Content_ area of the backoffice, find the _Zapier Integrations_ dashboard. |
| 40 | + |
| 41 | +The dashboard is composed of two sections: |
| 42 | +* Content Properties - Zapier details and input fields for adding content configurations |
| 43 | +* Registered Webhooks - list of created content configurations |
| 44 | + |
| 45 | +Each content type can only have one webhook configuration attached. After a configuration has been added for a specific content type, the content type item gets removed from the input field, |
| 46 | +and it can be restored by deleting the configuration from the database. |
| 47 | + |
| 48 | +The _Trigger Webhook_ action will send a test request to the Zap trigger, enabling the preview of requests in the Zap setup workflow. |
0 commit comments