How to Configure Gutena Forms REST API Settings

Estimated reading: 5 minutes 47 views

Gutena Forms REST API Settings allow external applications, such as chatbots, to submit entries to your forms. This guide explains how to enable REST API access, configure API key authentication, and test a form submission.

Requirements

You need administrator access to your WordPress dashboard to configure the REST API Settings.

Configure Gutena Forms REST API Settings

Step 1: Open the REST API Settings

  • From your WordPress dashboard, go to Gutena Forms → Settings.
  • Select REST API from the settings menu.
REST API Settings section in the Gutena Forms WordPress dashboard.

Step 2: Enable REST API Access

Turn on Enable REST API to allow external applications to submit form entries through the REST API endpoint.

Step 3: Configure API Key Authentication

Enable Require API Key to require an API key when submitting form entries through the endpoint.

When enabled, requests must include the API key in the X-Gutena-API-Key header.

Important: When Require API Key is disabled, the endpoint is publicly accessible, allowing anyone to submit requests. When enabled, only logged-in users with the required API key can access it.

Step 4: Save Your Settings

  1. Click Save Settings.
  2. Locate REST API Endpoint and Your API Key in the settings panel.

The API key is generated when the settings are initially saved.

Gutena Forms REST API Settings with API access and API key authentication enabled.

Step 5: Copy Your API Credentials

  1. Click the copy icon next to REST API Endpoint to copy the endpoint URL.
  2. Click the copy icon next to Your API Key to copy the API key.
  3. Use these values in the external application that will submit form entries.

Warning: Keep your API key private. Do not include it in public screenshots, website content, or support requests.

Find Your Form ID and Field IDs

Before sending entries through the REST API, identify the form and its fields.

Find the Form ID

  1. Go to Gutena Forms → Forms.
  2. Click the edit icon for the form.
  3. Find the form ID in the editor URL.

For example, in:

post.php?post=9&action=edit

The Form ID is 9.

Form ID shown in the WordPress editor URL.

Find the Field IDs

  1. Open the form in the editor.
  2. Select the field you want to populate.
  3. In the block sidebar, find FIELD ID under Field settings (for example, f_0).

The Field IDs are used to identify the form fields in your API request.

Note: Each field ID in the request must match the corresponding field in your form.

Field ID setting in the Gutena Forms block sidebar.

Test Your REST API Configuration

After enabling the REST API, send a test submission to confirm that the endpoint works.

Step 1: Prepare the Request

Use the endpoint URL from REST API Endpoint.

The submission endpoint is:

https://your-site.com/wp-json/gutena-forms/v1/submit-entry

Replace the example URL with your own endpoint.

Step 2: Send a Test Entry

Send a POST request containing the Form ID and field values.

For example, using curl:

curl -X POST "https://your-site.com/wp-json/gutena-forms/v1/submit-entry" \
  -H "Content-Type: application/json" \
  -H "X-Gutena-API-Key: your-api-key" \
  -d '{
    "form_id": "9",
    "fields": {
      "your_field_id": "Test value"
    }
  }'

Replace:

  • your-site.com with your website domain.
  • your-api-key with your API key.
  • 9 with your actual Form ID.
  • your_field_id with the correct Field ID.

Note: If Require API Key is disabled, the API key header is not required.

Step 3: Verify the Submission

A successful request returns the following response:

{
  "status": "Success",
  "message": "Entry stored"
}

To confirm the entry was saved:

  1. Go to Gutena Forms → Entries.
  2. Open the entries for the relevant form.
  3. Check that your test submission appears.

Note: Use valid Field IDs. The endpoint skips unrecognized field IDs.

Troubleshooting

Why is my REST API endpoint not working?

REST API access may be disabled, or you may be using an incorrect endpoint URL. Go to Gutena Forms → Settings → REST API, ensure Enable REST API is turned on, and click Save Settings. Copy the correct URL from REST API Endpoint and try sending the request again.

Why am I getting an API key authentication error?

The API key may be missing or incorrect when Require API Key is enabled. Copy the key from Your API Key and include it in the X-Gutena-API-Key header. Also ensure you’re authenticated as a logged-in user if required by your configuration, then retry the request.

Why is my REST API request being rejected?

Your request may contain missing or invalid form information. Make sure the JSON body includes a valid form_id and a fields object containing the form data. Check that the Form ID belongs to an existing form, then resend the request.

Why is my form entry not appearing after an API submission?

The Field IDs in your request may not match those configured in the form. Open the form in the WordPress editor, verify each Field ID, and update the corresponding keys in your API request. Submit another test entry and check Gutena Forms → Entries.

Need Help?

If you’re having trouble configuring REST API Settings, contact our support team with your settings and any error messages. Do not share your API key or other sensitive information.

Leave a Reply

Your email address will not be published. Required fields are marked *

Share this Doc

How to Configure Gutena Forms REST API Settings

Or copy link

CONTENTS
Scroll to Top