# Welcome

Welcome to Formspector. A tool that helps you to setup automated recurring front-end tests for your website forms without coding.

Formspector fills out your form on a daily basis. If something does not work, we will send you a notification immediately.


# Setup your first Formspector

Learn how to setup and activate your first Formspector.

### 1) Type in the url where we can find your form

First of all we need to know where we can find the form Formspector you should test for you. On our website you can enter the url and click the button "Setup".

![Screenshot: Formspector website with setup form](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2F1GfSBiR9ejzkESdp2rWA%2Fformspector-website.png?alt=media\&token=125623a3-e248-4338-ab53-3ba388f5b9de)

Then we redirect you directly inside the app. If you want you can already give your Formspector a name. Press the button "Continue" then.

![Screenshot: Set a name and hit continue](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2Fq8w6bnRnOsJuwOHeOaWa%2Fformspector-crawling.png?alt=media\&token=0a617162-91b9-4bfd-ba66-097e6624e2ad)

### 2) Choose the right form

Formspector is crawling the URL now and is checking for forms. You will see the forms we found in a list with the name of the fields. Select the form you want to test.

![Screenshot: result list with forms](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2FQCbGpGJVdSo6MO6OqveT%2Fselect-form-formspector.png?alt=media\&token=deac1ae3-222a-4e2b-afd1-cdbe65375703)

### 3) Set the default values

When you select the form you want to test, we will ask you about the default values we should use when we test your form.&#x20;

Because we are generating a new email address for every for submission, it is important that you tell us which field the email field is. Read more about [the email field](/fundamentals/email-address-field) or [honeypot fields](/fundamentals/honeypot-fields).

{% hint style="info" %}
**Tipp:** If you want to filter out our submissions in your system, use a special string in a field that detects us in your database.
{% endhint %}

![Screenshot: Set default values Formspector should use](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2F7Hv4uYC2H3QMtiIRPVeP%2Fset-default-values-formspector.png?alt=media\&token=c307c035-f67e-4423-9ce6-c5b6a62a49af)

### 4) Define a success submission

We need to know when a submission was successful. There are two different ways for us to check it. On the one hand, we can look for a success message on the website. But we can also check for the receipt of a confirmation email.

Choose your option and enter a text so that we can detect the success message.

![Screenshot: Define successful submission](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2Fsoksz9ZmGyGE1L5P9UHO%2Fsuccess-message-formspector.png?alt=media\&token=96c26afb-23ae-4156-83a8-fee6c7c9fa35)

### 5) Formspector Alert

Now you can define how we should inform you when the form is not working anymore. That's the last step and your formspector is up and running then.

![Screenshot: Setup Formspector Alert](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2Fb5LW2sxDWTgbhXlWamnT%2Fformspector-alert-setup.png?alt=media\&token=6fe43daf-82a3-4265-b273-0a2e87ca3619)


# Make your form accessible

This page will be available in a bit. Please write us an email if you have problems setting up a Formspector: <info@formspector.com>


# Deactivate a Formspector

You can deactivate an active Formspector very easily via the Dashboard. On the right side of your Formspector you will find an On and Off button. You can click this button to change the status.

![Screenshot Formspector: Deactivate Formspector](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2FLGNj7mnGKu2Yn5uzMAts%2Fdeactivate-formspector.png?alt=media\&token=dd103393-3438-43d0-b53d-e86a02e5fff7)


# Email Address Field

In most forms, input in the email address field is a unique value that occurs only once in all submissions. That's why we generate a new unique email address for each of our tests, so that we always test your form as a "new user".

In order for us to know which of your fields is the email address field, you can set it in step 2 of the setup process.

![Screenshot Formspector: Set the email address field during the setup process.](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2FdjThbdTKxue9zgnJqH00%2Fset-email-address-field-formspector.png?alt=media\&token=4af25989-2feb-4e1a-8270-ca42d6717356)


# Success Message

Whether the form was successfully submitted is confirmed to the user in the standard case with a success message in the user interface. We check if this success message is displayed after sending or not.

It does not matter whether the success message is displayed on the same page or the user is redirected to a separate new page.

Just choose "Page contains text" in the section "Define successful test" and type a text string that appears in the success message on your page.

![Screenshot Formspector: Choose type of success feedback](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2Fsoksz9ZmGyGE1L5P9UHO%2Fsuccess-message-formspector.png?alt=media\&token=96c26afb-23ae-4156-83a8-fee6c7c9fa35)


# Confirmation Email

Part of our automated is also checking confirmation emails that the user should receive after submitting a form. This step is optional and can simply be skipped if it is not needed.

When testing your form, we generate a new unique email address each time, which we enter into the email field of your form. We then wait 15 minutes after sending for an incoming email to that address. If an email is expected but none arrives contrary to expectations, we trigger an alert.

Just choose "Email received" in the section "Define successful test" and we will check our inbox for incoming emails.

![Screenshot Formspector: Set "Email received" as success test](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2FJDakG5Z8RURIk0LWTWEU%2Femail-received-test-formspector.png?alt=media\&token=59276b52-a522-4807-8b3b-843933d5c811)


# Formspector Alert

The way we inform you that one of your Formspectors detected an issue.

If one of your forms has some issues and Formspector is detecting it, you will get an alert. In the free version we will send you an email to your account address. It will tell you the following details:

* Domain were the form is implemented
* When we checked the issue
* Link to all details in the Formspector web app

In our planned Pro-Version you will be able to set different email address and also different channels like Slack, SMS or Webhooks.

![Example of a Formspector alert email](https://496075497-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FY70PxceY60biXL1PhWXt%2Fuploads%2FQhSakfijUcg6anq3wODZ%2Fformspector-alert-example.png?alt=media\&token=ee9870d3-bf8a-44dc-85ff-9bc333e0d78d)


# Honeypot Fields

What is a honeypot field and how to deal with it in Formspector?

### What is a honeypot field?

A honeypot field is a trap for automated spam-software. It's a hidden field that a normal user will never see. Sometimes it's a field with the type `hidden` in most of the cases it is made hidden with some special CSS styles.

Since a normal user would never see this field, he would never fill it in. Thus, if it is filled in, you can assume that an automated software is trying to fill in the form with spam data.

### How to deal with it in Formspector?

Since Formspector has no intention of being recognized as spam software, this field should simply be left blank. So you can just skip it when filling the default values.


