SimpliServDocs

WordPress plugin

Embed a customizable registration form on your site via a WordPress plugin. Every submission automatically creates a service registration in SimpliServ and starts the associated customer case.

→ Open the API Keys connector in SimpliServ

With the WordPress plugin SimpliServ Customer Registration Form you embed a customizable registration form directly on your WordPress site. Every submission automatically creates a service registration in SimpliServ and starts the associated customer case (CustomerFlow) – all without visitors needing a login.

The plugin sends its data to the same endpoint as the internal service registration form. How you set the fields, copy and logic of the service registration in SimpliServ is described in the guide Customize the service registration form. You'll find the general form builder under Building forms.

How it works

The plugin renders an HTML form on your WordPress page via a shortcode. On submit, the plugin calls the SimpliServ API server-side (POST /api/v1/service-registrations) and authenticates with an API key (bearer token). The token is never visible in the browser but stays in the WordPress settings.

From this, the following arises in SimpliServ:

  • a service registration with its own number,
  • a customer case that processes the registration,
  • for a known email address, the assignment to an existing customer.

Step 1 – Create an API key in SimpliServ

The plugin needs a token to identify itself to SimpliServ.

Open connectors

In SimpliServ, go to Administration → Organisation → Connectors and open the API Keys tile there.

Create a new integration

In the Configuration tab, click New integration. Assign a name (e.g. "WordPress form"), choose the roles the integration may use, and optionally set an expiry date.

Copy the token

After saving, the token is shown once. Copy it immediately – it has the format id|token and can't be viewed again later.

The assigned roles need the permission to create service registrations, otherwise the API rejects every submission. If you lose the token, simply create a new one and replace it in the plugin – an existing key can be revoked at any time.

Step 2 – Install the plugin in WordPress

Upload the plugin

Upload the plugin files to the /wp-content/plugins/ directory or install the plugin directly via the WordPress plugin screen.

Activate the plugin

Activate SimpliServ Customer Registration Form under Plugins in the WordPress admin area. On activation, the plugin creates its default settings.

Open the settings

In WordPress, open Settings → SimpliServ Form. Here you configure the connection, fields and anti-spam.

Step 3 – Configure the connection

In the General Settings section you set where and with what the plugin sends:

  • API Key (Bearer Token) – the token copied in step 1 (id|token).
  • API Base URL – the default is https://api.simpliserv.com. The plugin automatically appends /api/v1/service-registrations; a base URL with or without /api/v1 is resolved correctly.
  • Success Message – the text shown after a successful submission.
  • Redirect URL (optional) – instead of the success message, the user is redirected to this address.
  • Enable Honeypot – a hidden spam-protection field (recommended, on by default).
  • Rate Limit per Minute – the maximum submissions per IP and minute (default 10, 0 disables the limit).
  • Enable Debug Logging – writes requests and API responses to an internal log.

Step 4 – Customize the fields

In the Field Configuration section you control per field whether it's shown (Enabled) and required (Required), and override the label, placeholder and description.

Base fields:

  • First name (first_name), last name (last_name), email (email), phone (phone)
  • Brand (brand), model (model)
  • Description (description) – rendered as a multi-line text field

Address groups (shipping and billing address) are disabled by default. If you enable fields in them, they appear as their own group (address, city, postcode, region, country code) and are sent along as shipping_address or billing_address.

The fields first name, last name, email, phone and model are fixed to "active" and "required" in the plugin and can't be turned off (marked "Required by API"). All input is limited to a maximum of 255 characters and the email address is checked for validity.

In the Brand Field Settings section you can render the brand field either as a free text field or as a select dropdown. For the dropdown, enter the values under Brand Options – one per line or comma-separated.

Step 5 – Embed the form

Insert the following shortcode into a WordPress page or post:

[simpliserv_customer_form]

The form automatically takes over all enabled fields, the honeypot field and the stored success message. The form's CSS and JavaScript are only loaded on pages that contain the shortcode.

Diagnostics

In the lower part of the plugin settings, several tools help with troubleshooting:

  • REST endpoint – the WordPress address the form calls internally (…/simpliserv/v1/submit).
  • Last form hit – the timestamp and IP of the last submission.
  • Debug Logs – with logging active, requests and API responses are shown here; with Clear logs you empty the log, with Write test log entry you check whether logging is writing.

Common messages:

  • "Missing API key" – no token is stored in the plugin.
  • Validation error – a required field is missing or the email is invalid; the errors appear directly on the relevant field.
  • "Too many requests" – the rate limit per IP was reached.

If the API returns an error code (e.g. 401/403), check the token, base URL and the key's role permissions. You can revoke or re-issue the key at any time under Connectors → API Keys.

Further processing in SimpliServ

Incoming submissions appear as service registrations and can be processed like all other registrations – e.g. converted into an order, estimate or proposal. Details in the guide Service registration.

How is this guide?

On this page