Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions docs/components/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@ Creating a new Form
To create a new Form:

#. Go to Components > Forms and click New
#. Select the type of Form you wish to create
* **Campaign Form** - Mautic allows you to trigger a Campaign with the submission of this type of Form. Campaign Forms have less actions directly associated with the Form submit actions - which happen immediately after Form submission - as most actions trigger as part of a Campaign workflow.
* **Standalone Form** - A more commonly used Form, this allows the execution of many submit actions immediately at the point of Form submission.

.. warning::
Forms with a lot of submit actions - particularly when submitting to third party systems such as a Customer Relationship Management system - can have an impact on the Form submission time. This is especially the case if there are a lot of fields. Consider using a Campaign Form if you can wait for the cron job to trigger the actions.
.. note::
All Forms in Mautic can trigger Campaigns and have access to the full range of Form actions. You can use Forms as a Contact source in Campaigns to trigger workflows when Contacts submit them.

The following fields are available:

Expand Down Expand Up @@ -51,7 +48,7 @@ Configuring Forms
*****************
.. vale on

Once you have selected the type of Form, you have some additional options to set.
Once you have created a new Form, you have some additional options to set.

Details
=======
Expand All @@ -66,9 +63,9 @@ The available details fields are:
* **Display message** - shows a message over the Form once the Contact has submitted the Form.
- **Redirect URL/Message** - If you decide to use the Redirect URL successful submit action, paste the URL where you'd like to direct submitters. If you use Display message, enter the message to display.

.. image:: images/forms/standalone_form.png
.. image:: images/forms/new_form.png
:width: 600
:alt: Screenshot showing standalone Form
:alt: Screenshot showing new Form

Fields
======
Expand Down Expand Up @@ -320,9 +317,6 @@ Form actions

You may want to trigger certain actions to happen immediately after Form submission - this is what Form actions are for. This might include communications with the Contact, tracking, internal notifications, or other Contact management tasks.

.. note::
The Form actions available in Mautic are also available in Standalone Forms, which include more options as they're not associated with Campaigns. Campaigns tend to trigger most actions through Campaign actions so Forms associated with Campaigns only have a basic set of Form actions.

- **Add to Company's Score**: if a Contact associated with a Company record in Mautic has submitted the Form, you can add or subtract Points to the Company's overall score. Company scoring in Mautic doesn't aggregate Points for all its associated Contacts. Any actions that you want to contribute to a Company's score must be explicitly set. Negative numbers are valid if you want to subtract from a Company's score based on a Contact submitting a Form. If the Contact isn't tracked and the Form doesn't include a field mapped to Company or Company Name - on the Company object - the Company has no Points awarded.

.. image:: images/forms/add_to_company_score.png
Expand Down
Binary file added docs/components/images/forms/new_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/components/images/forms/standalone_form.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/plugins/plugin_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ If you want to test an Integration Plugin to ensure that it's configured properl

* The **Campaign Builder** has the *Push Contact to Integration* action which can be used in the Campaign configuration.

* The **Standalone Form** has the *Push Contact to Integration* action which can be used after a standalone Form is submitted.
* **Forms** include the **Push Contact to Integration** action, which triggers after a Form submission.

* The **Points Trigger** has the *Push Contact to Integration* action which can be triggered when a Contact achieves a configured point limit.

Use any of those actions to test the Plugin and see if the Contact appears in the Integration. Here is an example of how you can configure the Standalone Form action:
Use any of those actions to test the Plugin and see if the Contact appears in the Integration. Here is an example of how you can configure the Form action:

.. image:: images/push-integration.png
:alt: Screenshot of push Integration
Expand Down
6 changes: 5 additions & 1 deletion docs/segments/manage_segments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,11 @@ Form submit action

.. vale on

**Modify Contact's Segment** is available as a submit action on :ref:`Standalone Forms<creating a new form>`. With a Campaign Form, create a Campaign with a **Modify Contact's Segment** action.
.. vale off

**Modify Contact's Segment** is available as a submit action on :ref:`Forms<creating a new form>`.

.. vale on

1. Click **Actions**.

Expand Down