AdonisJSuse Fetchski\AttractCmsLaravel\Facades\Attract;
$form = Attract::forms()->createForm(title: 'Example title', visibility: 'public', email: 'jo@acme.example');
{
"title": "Example title",
"contents": {
"metaType": "area",
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"items": [
{
"type": "form-section",
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"metaType": "widget",
"formFontOverrides": [],
"formEyebrowEnabled": true,
"formEyebrow": "Get in touch",
"formEyebrowColor": "Example form eyebrow color",
"formEyebrowColorLight": "Example form eyebrow color light",
"formEyebrowWeight": "bold",
"formEyebrowSize": "normal",
"formHeading": "Send us a message",
"formHeadingColor": "Example form heading color",
"formHeadingColorLight": "Example form heading color light",
"formHeadingWeight": "extrabold",
"formHeadingSize": "normal",
"formIntro": "Fill out the form below and we’ll get back to you shortly.",
"formIntroColor": "Example form intro color",
"formIntroColorLight": "Example form intro color light",
"formIntroWeight": "normal",
"formIntroSize": "normal",
"formBand": "raised",
"formAccentColor": "Example form accent color",
"formAccentColorLight": "Example form accent color light",
"formAlign": "center",
"formWidth": "normal",
"formLabelGap": "normal",
"formBg": "transparent",
"formBgCustom": "Example form bg custom",
"formBgLight": "inherit",
"formBgLightCustom": "Example form bg light custom",
"formSubmitLabel": "Submit",
"formSubmitVariant": "solid",
"formSubmitSize": "normal",
"formSubmitRadius": "slight",
"formSubmitColor": "--fetchski-accent",
"formSubmitColorLight": "Example form submit color light",
"formSubmitTextColor": "--fetchski-ink",
"formSubmitTextColorLight": "Example form submit text color light",
"formSubmitHoverColor": "Example form submit hover color",
"formSubmitHoverColorLight": "Example form submit hover color light",
"formSubmitStyle": "sweep",
"formSubmitShadowColor": "Example form submit shadow color",
"formSubmitShadowColorLight": "Example form submit shadow color light",
"formSubmitAnimation": "lift-scale",
"formSubmitIcon": "Example form submit icon",
"formSubmitIconFamily": "classic-regular",
"formSubmitIconPosition": "before",
"formSubmitIconNudge": false,
"_form": [
{}
],
"sectionCss": {
"slots": {
"key": "Example value"
},
"css": "Example css",
"mark": "Example mark"
},
"fields": {
"metaType": "area",
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"items": [
{}
]
}
}
]
},
"slug": "example-slug",
"visibility": "public",
"scheduledPublish": "Example scheduled publish",
"scheduledUnpublish": "Example scheduled unpublish",
"thankYouHeading": "Example thank you heading",
"thankYouBody": {
"metaType": "area",
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"items": [
{
"type": "@apostrophecms/rich-text",
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"metaType": "widget",
"content": "<p>Hello from the API.</p>",
"sectionCss": {
"slots": {
"key": "Example value"
},
"css": "Example css",
"mark": "Example mark"
}
}
]
},
"sendConfirmationEmail": true,
"emailConfirmationField": "jo@acme.example",
"emails": [],
"email": "jo@acme.example",
"googleSheetSubmissions": true,
"googleSpreadsheetId": "clx8m2k4p0000a1b2c3d4e5f6",
"googleSheetName": "Example google sheet name",
"submitLabel": "Example submit label",
"enableRecaptcha": true,
"enableQueryParams": true,
"queryParamList": [],
"formActions": [],
"archived": false,
"_id": "clx8m2k4p0000a1b2c3d4e5f6",
"type": "Example type",
"createdAt": "2026-10-24T09:30:00.000Z",
"updatedAt": "2026-10-24T09:30:00.000Z",
"aposShareKey": "k3v9x2m7q1z8w4p6"
}
In your app
A controller answers a route on your app: it callscreateForm() and returns the answer.
Add the controller
app/Http/Controllers/CreateFormController.php
<?php
declare(strict_types=1);
namespace App\Http\Controllers;
use Fetchski\AttractCmsLaravel\Data\Form;
use Fetchski\AttractCmsLaravel\Facades\Attract;
final class CreateFormController
{
public function __invoke(): Form
{
return Attract::forms()->createForm(title: 'Example title', visibility: 'public', email: 'jo@acme.example');
}
}
Add the route
routes/web.php
use App\Http\Controllers\CreateFormController;
use Illuminate\Support\Facades\Route;
Route::post('/form', CreateFormController::class)->middleware('auth');
auth lets only your signed-in users reach it.Call it
Your own page’s form or script sends
POST /form (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.To keep the call in an Action instead, this writes
app/Actions/Attract/CreateForm.php (an invokable Action that calls createForm()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):Terminal
php artisan make:attract-action forms.createForm
Call it from the terminal
Terminal
php artisan attract:call forms.createForm \
'title=Example title' \
visibility=public \
email=jo@acme.example
createForm() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type.
Required parameters
Required parameters
Named arguments, e.g.
createForm(title: …); leave out the optional ones.Required. Its title: the name it goes by in every list, and the heading of its page where it has one.
Required. Select whether this content is public or private. One of
public, loginRequired.Optional parameters
Optional parameters
Optional. Leave it out and the site uses
"published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with form-section.Show FormSectionArea (Fetchski\AttractCmsLaravel\Data\FormSectionArea)
Show FormSectionArea (Fetchski\AttractCmsLaravel\Data\FormSectionArea)
A list of
FormSectionWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). At most 1 items.Show FormSectionWidget (Fetchski\AttractCmsLaravel\Data\FormSectionWidget)
Show FormSectionWidget (Fetchski\AttractCmsLaravel\Data\FormSectionWidget)
A
form-section widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
form-section. One of form-section.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
A list of
FormSectionWidgetFormFontOverridesItem. Optional. Set part of this form in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.Show FormSectionWidgetFormFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItem)
Show FormSectionWidgetFormFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItem)
Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of
all, heading, body, eyebrow, button, code.Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of
slot, curated, cdn, upload.Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of
display, body, accent.Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of
archivo, bricolage-grotesque, clash-display, courier-prime, dm-mono, dm-sans, fira-code, fraunces, general-sans, ibm-plex-mono, ibm-plex-sans, inconsolata, inter, jetbrains-mono, karla, lora, manrope, nunito-sans, outfit, playfair-display, public-sans, red-hat-mono, satoshi, sentient, sora, source-code-pro, source-sans-3, source-serif-4, space-grotesk, space-mono, spline-sans-mono, supreme, switzer, syne, ubuntu-mono, unbounded, victor-mono, work-sans, zodiak.Where to browse for the family. Pick one, then follow the link below to find the exact name. One of
bunny, fontshare.Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”. A name the provider doesn’t have loads nothing and this row is ignored.
Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.
A list of
FormSectionWidgetFormFontOverridesItemUploadsItem. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.Show FormSectionWidgetFormFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItemUploadsItem)
Show FormSectionWidgetFormFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItemUploadsItem)
Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of
sans, serif, mono.Eyebrow weight. One of
normal, medium, semibold, bold, extrabold.Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of
plain, raised, accent.Alignment of the section header (the form fields stay left-aligned for legibility). One of
center, left.Vertical space between each field’s label and its input. One of
compact, normal, roomy, spacious.The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of
transparent, surface, raised, sunken, hill, accent-soft, custom.“Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of
inherit, transparent, surface, raised, sunken, hill, accent-soft, custom.Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of
solid, outline, soft, link.Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.
Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)
The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of
none, single, dual, glow, sweep, thicken.Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.
Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.
Icon family. One of
classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard.Which side of the label the icon sits on (when an icon name is set). One of
before, after.The Form record that stores this form’s submissions and routes them (its Actions / integrations / Google Sheet). Create one in the Forms manager. The fields themselves are built right here on the page. The related
@apostrophecms/form documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.A
CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot.A
FormSectionFieldsArea. Add and arrange the form’s fields here — edited live on the page. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormSectionFieldsArea (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsArea)
Show FormSectionFieldsArea (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsArea)
Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormConditionalWidget|FormGroupWidget|FormDividerWidget|RichTextWidget>|null
A list of
FormSectionFieldsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them).Show FormSectionFieldsAreaItem (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsAreaItem)
Show FormSectionFieldsAreaItem (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsAreaItem)
A widget in an area that takes
@apostrophecms/form-text-field, @apostrophecms/form-textarea-field, @apostrophecms/form-file-field, @apostrophecms/form-boolean-field, @apostrophecms/form-select-field, @apostrophecms/form-radio-field, @apostrophecms/form-checkboxes-field, @apostrophecms/form-conditional, @apostrophecms/form-group, @apostrophecms/form-divider, @apostrophecms/rich-text: the one its type names.Show FormTextFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextFieldWidget)
Show FormTextFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextFieldWidget)
A
@apostrophecms/form-text-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-text-field. One of @apostrophecms/form-text-field.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
If you are requesting certain formatted information (e.g., email, url, phone number), select the relevant input type here. If not, use “Text”. One of
text, email, tel, url, date, password.Text to display in the field before someone uses it (e.g., to provide additional directions).
Show FormTextareaFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextareaFieldWidget)
Show FormTextareaFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextareaFieldWidget)
A
@apostrophecms/form-textarea-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-textarea-field. One of @apostrophecms/form-textarea-field.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Text to display in the field before someone uses it (e.g., to provide additional directions).
Show FormFileFieldWidget (Fetchski\AttractCmsLaravel\Data\FormFileFieldWidget)
Show FormFileFieldWidget (Fetchski\AttractCmsLaravel\Data\FormFileFieldWidget)
A
@apostrophecms/form-file-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-file-field. One of @apostrophecms/form-file-field.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Show FormBooleanFieldWidget (Fetchski\AttractCmsLaravel\Data\FormBooleanFieldWidget)
Show FormBooleanFieldWidget (Fetchski\AttractCmsLaravel\Data\FormBooleanFieldWidget)
A
@apostrophecms/form-boolean-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-boolean-field. One of @apostrophecms/form-boolean-field.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Show FormSelectFieldWidget (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidget)
Show FormSelectFieldWidget (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidget)
A
@apostrophecms/form-select-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-select-field. One of @apostrophecms/form-select-field.Required. A list of
FormSelectFieldWidgetChoicesItem. Select input options.Show FormSelectFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidgetChoicesItem)
Show FormSelectFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidgetChoicesItem)
The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Show FormRadioFieldWidget (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidget)
Show FormRadioFieldWidget (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidget)
A
@apostrophecms/form-radio-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-radio-field. One of @apostrophecms/form-radio-field.Required. A list of
FormRadioFieldWidgetChoicesItem. Radio input options. At least 1 items.Show FormRadioFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidgetChoicesItem)
Show FormRadioFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidgetChoicesItem)
The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Show FormCheckboxesFieldWidget (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidget)
Show FormCheckboxesFieldWidget (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidget)
A
@apostrophecms/form-checkboxes-field widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-checkboxes-field. One of @apostrophecms/form-checkboxes-field.Required. A list of
FormCheckboxesFieldWidgetChoicesItem. Checkbox input options. At least 1 items.Show FormCheckboxesFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidgetChoicesItem)
Show FormCheckboxesFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidgetChoicesItem)
The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.
Show FormConditionalWidget (Fetchski\AttractCmsLaravel\Data\FormConditionalWidget)
Show FormConditionalWidget (Fetchski\AttractCmsLaravel\Data\FormConditionalWidget)
A
@apostrophecms/form-conditional widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-conditional. One of @apostrophecms/form-conditional.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
A
FormConditionalContentsArea. aposForm:conditionalContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormConditionalContentsArea (Fetchski\AttractCmsLaravel\Data\FormConditionalContentsArea)
Show FormConditionalContentsArea (Fetchski\AttractCmsLaravel\Data\FormConditionalContentsArea)
Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormDividerWidget|RichTextWidget>|null
A list of
FormConditionalContentsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first FormConditionalContentsAreaItem above.Show FormGroupWidget (Fetchski\AttractCmsLaravel\Data\FormGroupWidget)
Show FormGroupWidget (Fetchski\AttractCmsLaravel\Data\FormGroupWidget)
A
@apostrophecms/form-group widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-group. One of @apostrophecms/form-group.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
A
FormGroupContentsArea. aposForm:groupContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormGroupContentsArea (Fetchski\AttractCmsLaravel\Data\FormGroupContentsArea)
Show FormGroupContentsArea (Fetchski\AttractCmsLaravel\Data\FormGroupContentsArea)
Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormConditionalWidget|FormDividerWidget|RichTextWidget>|null
A list of
FormGroupContentsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first FormGroupContentsAreaItem above.Show FormDividerWidget (Fetchski\AttractCmsLaravel\Data\FormDividerWidget)
Show FormDividerWidget (Fetchski\AttractCmsLaravel\Data\FormDividerWidget)
A
@apostrophecms/form-divider widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/form-divider. One of @apostrophecms/form-divider.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)
Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)
A
@apostrophecms/rich-text widget: its type and its own fields. A field left out takes its default.Required. The widget’s type: always
@apostrophecms/rich-text. One of @apostrophecms/rich-text.The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.
The text as HTML, e.g.
<h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.A
CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot. Its fields are listed under the first CustomCSS above.Optional. Leave it out and the site uses
"". The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show RichTextArea (Fetchski\AttractCmsLaravel\Data\RichTextArea)
Show RichTextArea (Fetchski\AttractCmsLaravel\Data\RichTextArea)
A list of
RichTextWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first RichTextWidget above.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Enable this to send a message to the person who submits this form.Optional. Leave it out and the site uses
"". Enter the “name” value of the field where people with enter their email address. For best results, make sure this field only accepts email addresses.array<int, FormEmailsItem|array<string, mixed>>|Collection<int, FormEmailsItem|array<string, mixed>>|null
Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Email Address(es) for Results.Show FormEmailsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItem)
Show FormEmailsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItem)
A list of
FormEmailsItemConditionsItem. For example, if you only notify this email address if the “country” field is set to “Austria”. All conditions must be met. Add the email again with another conditional set if needed.Show FormEmailsItemConditionsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItemConditionsItem)
Show FormEmailsItemConditionsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItemConditionsItem)
Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Submit to Google Spreadsheets.Optional. Leave it out and the site uses
"". The name of the sheet tab in your Google spreadsheet where you want the submission appended. If not provided, the first sheet of the spreadsheet will be used.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. To use, reCAPTCHA a site ID and secret key must be configured in website code or the website global settings.Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Enable query parameter capture.array<int, FormQueryParamListItem|array<string, mixed>>|Collection<int, FormQueryParamListItem|array<string, mixed>>|null
Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. Create an array item for each query parameter value you wish to capture.Show FormQueryParamListItem (Fetchski\AttractCmsLaravel\Data\FormQueryParamListItem)
Show FormQueryParamListItem (Fetchski\AttractCmsLaravel\Data\FormQueryParamListItem)
array<int, FormFormActionsItem|array<string, mixed>>|Collection<int, FormFormActionsItem|array<string, mixed>>|null
Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. What happens to each submission, beyond being stored in the CMS. Add one row per destination; several can run for one form. Storage always happens regardless.Show FormFormActionsItem (Fetchski\AttractCmsLaravel\Data\FormFormActionsItem)
Show FormFormActionsItem (Fetchski\AttractCmsLaravel\Data\FormFormActionsItem)
Where each submission is sent (⌘K → Webhook Destinations). It is signed with that destination’s secret, retried if the receiver is down, and listed on its Deliveries tab. The related
webhook-destination documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.Where a copy of each submission is emailed (sent through Connections → Email). Replying answers the visitor. When set, an email address; empty or null when not.
Returns
Returns
A
Form (Fetchski\AttractCmsLaravel\Data\Form). Form content type. Read its properties ($form->title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _form → form, _destination → destination).Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
Always sent. Select whether this content is public or private. One of
public, loginRequired; a newer site may send others, so keep a fallback.Always sent. The “from” address on this form’s emails. A new form starts with the Email in Site settings → Brand; change it here for this form.
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (
…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.Sometimes sent:
null when the site leaves it out. A FormSectionArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with form-section.Show FormSectionArea (Fetchski\AttractCmsLaravel\Data\FormSectionArea)
Show FormSectionArea (Fetchski\AttractCmsLaravel\Data\FormSectionArea)
Sometimes sent:
null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.Sometimes sent:
null when the site leaves it out. A list of FormSectionWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). At most 1 items.Show FormSectionWidget (Fetchski\AttractCmsLaravel\Data\FormSectionWidget)
Show FormSectionWidget (Fetchski\AttractCmsLaravel\Data\FormSectionWidget)
A
form-section widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
form-section. One of form-section; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. A list of FormSectionWidgetFormFontOverridesItem. Optional. Set part of this form in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.Show FormSectionWidgetFormFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItem)
Show FormSectionWidgetFormFontOverridesItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItem)
Sometimes sent:
null when the site leaves it out. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of all, heading, body, eyebrow, button, code; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of slot, curated, cdn, upload; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of display, body, accent; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of archivo, bricolage-grotesque, clash-display, courier-prime, dm-mono, dm-sans, fira-code, fraunces, general-sans, ibm-plex-mono, ibm-plex-sans, inconsolata, inter, jetbrains-mono, karla, lora, manrope, nunito-sans, outfit, playfair-display, public-sans, red-hat-mono, satoshi, sentient, sora, source-code-pro, source-sans-3, source-serif-4, space-grotesk, space-mono, spline-sans-mono, supreme, switzer, syne, ubuntu-mono, unbounded, victor-mono, work-sans, zodiak; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of bunny, fontshare; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. “Space Grotesk” or “Clash Display”. A name the provider doesn’t have loads nothing and this row is ignored.Sometimes sent:
null when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.Sometimes sent:
null when the site leaves it out. A list of FormSectionWidgetFormFontOverridesItemUploadsItem. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.Show FormSectionWidgetFormFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItemUploadsItem)
Show FormSectionWidgetFormFontOverridesItemUploadsItem (Fetchski\AttractCmsLaravel\Data\FormSectionWidgetFormFontOverridesItemUploadsItem)
Sometimes sent:
null when the site leaves it out. Weight. One of 100, 200, 300, 400, 500, 600, 700, 800, 900; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Style. One of normal, italic; a newer site may send others, so keep a fallback.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of sans, serif, mono; a newer site may send others, so keep a fallback.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color, then the mint default.Sometimes sent:
null when the site leaves it out. Eyebrow weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Eyebrow size. One of small, normal, large, xlarge; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Optional — leave empty to track the theme text color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color.Sometimes sent:
null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Size. One of small, normal, large, xlarge, xxlarge; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Optional — leave empty to use the muted text color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color.Sometimes sent:
null when the site leaves it out. Weight. One of normal, medium, semibold, bold, extrabold; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Size. One of small, normal, large, xlarge, xxlarge; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of plain, raised, accent; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The accent band color. Leave empty to use the site accent color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color, then the accent.Sometimes sent:
null when the site leaves it out. Alignment of the section header (the form fields stay left-aligned for legibility). One of center, left; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Content width. One of narrow, normal, wide; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Vertical space between each field’s label and its input. One of compact, normal, roomy, spacious; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of transparent, surface, raised, sunken, hill, accent-soft, custom; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Used when “Section background (dark theme)” is set to Custom color.Sometimes sent:
null when the site leaves it out. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of inherit, transparent, surface, raised, sunken, hill, accent-soft, custom; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Used when “Section background (light theme)” is set to Custom color.Sometimes sent:
null when the site leaves it out. The visible button text. Leave empty to hide the button.Sometimes sent:
null when the site leaves it out. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of solid, outline, soft, link; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Button size. One of small, normal, large; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Corner radius. One of pill, rounded, slight, square; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)Sometimes sent:
null when the site leaves it out. The text/icon color. Clear it to derive from the button color (readable on solid fills).Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme label color.Sometimes sent:
null when the site leaves it out. Optional. Drives the hover treatment. Leave empty to derive it from the button color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme hover color.Sometimes sent:
null when the site leaves it out. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of none, single, dual, glow, sweep, thicken; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.Sometimes sent:
null when the site leaves it out. Optional light-theme override. Falls back to the dark-theme shadow color.Sometimes sent:
null when the site leaves it out. Hover motion. One of lift, scale, lift-scale, none; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.Sometimes sent:
null when the site leaves it out. Icon family. One of classic-regular, duotone-regular, brands, jelly, jelly-duo, whiteboard; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Which side of the label the icon sits on (when an icon name is set). One of before, after; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).Sometimes sent:
null when the site leaves it out. The Form record that stores this form’s submissions and routes them (its Actions / integrations / Google Sheet). Create one in the Forms manager. The fields themselves are built right here on the page. The related @apostrophecms/form documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.Sometimes sent:
null when the site leaves it out. A CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot.Show CustomCSS (Fetchski\AttractCmsLaravel\Data\CustomCSS)
Show CustomCSS (Fetchski\AttractCmsLaravel\Data\CustomCSS)
Sometimes sent:
null when the site leaves it out. The CSS typed into each part slot, by slot name.Sometimes sent:
null when the site leaves it out. The compiled CSS (read only: rebuilt from slots).Sometimes sent:
null when the site leaves it out. A FormSectionFieldsArea. Add and arrange the form’s fields here — edited live on the page. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormSectionFieldsArea (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsArea)
Show FormSectionFieldsArea (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsArea)
Sometimes sent:
null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormConditionalWidget|FormGroupWidget|FormDividerWidget|RichTextWidget>|null
Sometimes sent:
null when the site leaves it out. A list of FormSectionFieldsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them).Show FormSectionFieldsAreaItem (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsAreaItem)
Show FormSectionFieldsAreaItem (Fetchski\AttractCmsLaravel\Data\FormSectionFieldsAreaItem)
A widget in an area that takes
@apostrophecms/form-text-field, @apostrophecms/form-textarea-field, @apostrophecms/form-file-field, @apostrophecms/form-boolean-field, @apostrophecms/form-select-field, @apostrophecms/form-radio-field, @apostrophecms/form-checkboxes-field, @apostrophecms/form-conditional, @apostrophecms/form-group, @apostrophecms/form-divider, @apostrophecms/rich-text: the one its type names.Show FormTextFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextFieldWidget)
Show FormTextFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextFieldWidget)
A
@apostrophecms/form-text-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-text-field. One of @apostrophecms/form-text-field; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Sometimes sent:
null when the site leaves it out. If you are requesting certain formatted information (e.g., email, url, phone number), select the relevant input type here. If not, use “Text”. One of text, email, tel, url, date, password; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Text to display in the field before someone uses it (e.g., to provide additional directions).Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormTextareaFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextareaFieldWidget)
Show FormTextareaFieldWidget (Fetchski\AttractCmsLaravel\Data\FormTextareaFieldWidget)
A
@apostrophecms/form-textarea-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-textarea-field. One of @apostrophecms/form-textarea-field; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Sometimes sent:
null when the site leaves it out. Text to display in the field before someone uses it (e.g., to provide additional directions).Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormFileFieldWidget (Fetchski\AttractCmsLaravel\Data\FormFileFieldWidget)
Show FormFileFieldWidget (Fetchski\AttractCmsLaravel\Data\FormFileFieldWidget)
A
@apostrophecms/form-file-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-file-field. One of @apostrophecms/form-file-field; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormBooleanFieldWidget (Fetchski\AttractCmsLaravel\Data\FormBooleanFieldWidget)
Show FormBooleanFieldWidget (Fetchski\AttractCmsLaravel\Data\FormBooleanFieldWidget)
A
@apostrophecms/form-boolean-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-boolean-field. One of @apostrophecms/form-boolean-field; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Sometimes sent:
null when the site leaves it out. If “yes,” the checkbox will start in the checked state.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormSelectFieldWidget (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidget)
Show FormSelectFieldWidget (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidget)
A
@apostrophecms/form-select-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-select-field. One of @apostrophecms/form-select-field; a newer site may send others, so keep a fallback.Always sent. A list of
FormSelectFieldWidgetChoicesItem. Select input options.Show FormSelectFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidgetChoicesItem)
Show FormSelectFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormSelectFieldWidgetChoicesItem)
Sometimes sent:
null when the site leaves it out. The value saved (as text) in the database. If not entered, the label will be used.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Sometimes sent:
null when the site leaves it out. Number of options in the list that should be visible. At least 0.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormRadioFieldWidget (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidget)
Show FormRadioFieldWidget (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidget)
A
@apostrophecms/form-radio-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-radio-field. One of @apostrophecms/form-radio-field; a newer site may send others, so keep a fallback.Always sent. A list of
FormRadioFieldWidgetChoicesItem. Radio input options. At least 1 items.Show FormRadioFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidgetChoicesItem)
Show FormRadioFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormRadioFieldWidgetChoicesItem)
Sometimes sent:
null when the site leaves it out. The value saved (as text) in the database. If not entered, the label will be used.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Sometimes sent:
null when the site leaves it out. Number of options in the list that should be visible. At least 0.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormCheckboxesFieldWidget (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidget)
Show FormCheckboxesFieldWidget (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidget)
A
@apostrophecms/form-checkboxes-field widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-checkboxes-field. One of @apostrophecms/form-checkboxes-field; a newer site may send others, so keep a fallback.Always sent. A list of
FormCheckboxesFieldWidgetChoicesItem. Checkbox input options. At least 1 items.Show FormCheckboxesFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidgetChoicesItem)
Show FormCheckboxesFieldWidgetChoicesItem (Fetchski\AttractCmsLaravel\Data\FormCheckboxesFieldWidgetChoicesItem)
Sometimes sent:
null when the site leaves it out. The value saved (as text) in the database. If not entered, the label will be used.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. No spaces or punctuation other than dashes. If left blank, the form will populate this with a simplified form of the label. Changing this field after a form is in use may cause problems with any integrations.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormConditionalWidget (Fetchski\AttractCmsLaravel\Data\FormConditionalWidget)
Show FormConditionalWidget (Fetchski\AttractCmsLaravel\Data\FormConditionalWidget)
A
@apostrophecms/form-conditional widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-conditional. One of @apostrophecms/form-conditional; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. A FormConditionalContentsArea. aposForm:conditionalContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormConditionalContentsArea (Fetchski\AttractCmsLaravel\Data\FormConditionalContentsArea)
Show FormConditionalContentsArea (Fetchski\AttractCmsLaravel\Data\FormConditionalContentsArea)
Sometimes sent:
null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormDividerWidget|RichTextWidget>|null
Sometimes sent:
null when the site leaves it out. A list of FormConditionalContentsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first FormConditionalContentsAreaItem above.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormGroupWidget (Fetchski\AttractCmsLaravel\Data\FormGroupWidget)
Show FormGroupWidget (Fetchski\AttractCmsLaravel\Data\FormGroupWidget)
A
@apostrophecms/form-group widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-group. One of @apostrophecms/form-group; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. A FormGroupContentsArea. aposForm:groupContentsHelp Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show FormGroupContentsArea (Fetchski\AttractCmsLaravel\Data\FormGroupContentsArea)
Show FormGroupContentsArea (Fetchski\AttractCmsLaravel\Data\FormGroupContentsArea)
Sometimes sent:
null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.Collection<int, FormTextFieldWidget|FormTextareaFieldWidget|FormFileFieldWidget|FormBooleanFieldWidget|FormSelectFieldWidget|FormRadioFieldWidget|FormCheckboxesFieldWidget|FormConditionalWidget|FormDividerWidget|RichTextWidget>|null
Sometimes sent:
null when the site leaves it out. A list of FormGroupContentsAreaItem. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first FormGroupContentsAreaItem above.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show FormDividerWidget (Fetchski\AttractCmsLaravel\Data\FormDividerWidget)
Show FormDividerWidget (Fetchski\AttractCmsLaravel\Data\FormDividerWidget)
A
@apostrophecms/form-divider widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/form-divider. One of @apostrophecms/form-divider; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)
Show RichTextWidget (Fetchski\AttractCmsLaravel\Data\RichTextWidget)
A
@apostrophecms/rich-text widget: its type and its own fields. A field left out takes its default.Always sent. The widget’s type: always
@apostrophecms/rich-text. One of @apostrophecms/rich-text; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.Sometimes sent:
null when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The text as HTML, e.g. <h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.Sometimes sent:
null when the site leaves it out. A CustomCSS. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and [data-theme=“light”] & work inside a slot. Its fields are listed under the first CustomCSS above.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
null when the site leaves it out. A RichTextArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Show RichTextArea (Fetchski\AttractCmsLaravel\Data\RichTextArea)
Show RichTextArea (Fetchski\AttractCmsLaravel\Data\RichTextArea)
Sometimes sent:
null when the site leaves it out. Always area. One of area; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. The area’s id, set by the site: leave it out when you write one.Sometimes sent:
null when the site leaves it out. A list of RichTextWidget. The widgets, top to bottom. Each is an object with its type and that widget’s own fields; _id and metaType may be left out (the site sets them). Its fields are listed under the first RichTextWidget above.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. Enable this to send a message to the person who submits this form.Sometimes sent:
null when the site leaves it out. Enter the “name” value of the field where people with enter their email address. For best results, make sure this field only accepts email addresses.Sometimes sent:
null when the site leaves it out. A list of FormEmailsItem. Email Address(es) for Results.Show FormEmailsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItem)
Show FormEmailsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItem)
Sometimes sent:
null when the site leaves it out. A list of FormEmailsItemConditionsItem. For example, if you only notify this email address if the “country” field is set to “Austria”. All conditions must be met. Add the email again with another conditional set if needed.Show FormEmailsItemConditionsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItemConditionsItem)
Show FormEmailsItemConditionsItem (Fetchski\AttractCmsLaravel\Data\FormEmailsItemConditionsItem)
Sometimes sent:
null when the site leaves it out. Only select (drop-down) and checkbox fields can be used for this condition.Sometimes sent:
null when the site leaves it out. Enter the value an end-user will enter to meet this conditional.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. The name of the sheet tab in your Google spreadsheet where you want the submission appended. If not provided, the first sheet of the spreadsheet will be used.Sometimes sent:
null when the site leaves it out. To use, reCAPTCHA a site ID and secret key must be configured in website code or the website global settings.Sometimes sent:
null when the site leaves it out. A list of FormQueryParamListItem. Create an array item for each query parameter value you wish to capture.Show FormQueryParamListItem (Fetchski\AttractCmsLaravel\Data\FormQueryParamListItem)
Show FormQueryParamListItem (Fetchski\AttractCmsLaravel\Data\FormQueryParamListItem)
Sometimes sent:
null when the site leaves it out. Enter a whole number to limit the length of the value saved. At least 1.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. A list of FormFormActionsItem. What happens to each submission, beyond being stored in the CMS. Add one row per destination; several can run for one form. Storage always happens regardless.Show FormFormActionsItem (Fetchski\AttractCmsLaravel\Data\FormFormActionsItem)
Show FormFormActionsItem (Fetchski\AttractCmsLaravel\Data\FormFormActionsItem)
Always sent. Action. One of
webhook, emailNotify; a newer site may send others, so keep a fallback.Sometimes sent:
null when the site leaves it out. Where each submission is sent (⌘K → Webhook Destinations). It is signed with that destination’s secret, retried if the receiver is down, and listed on its Deliveries tab. The related webhook-destination documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.Sometimes sent:
null when the site leaves it out. Where a copy of each submission is emailed (sent through Connections → Email). Replying answers the visitor. When set, an email address; empty or null when not.Always there:
[] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.Sometimes sent:
null when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.Errors
Errors
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
The site refused what was sent:
errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read:
siteMessage(), errorName(), data().The key may not do this: a scope it lacks, or an address outside its allowlist.
siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().Nothing matches, or the caller may not see it.Retried first: No. Read:
siteMessage(), errorName(), data().The site failed. Its logs say why.Retried first: No: a write may have landed. Read:
siteMessage(), errorName(), data().No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (
neverConnected()); never after a timeout, when it may have landed. Read: reason(), neverConnected().The client refused to send it (e.g. a path segment of
..); the site never saw it.Retried first: No. Read: reason() (what to change).Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason(), status().Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.Behavior
- Access: an API key with
content:forms:write(or a master above it:content:forms:all,content:all,admin:all). In published mode (the default) it goes live too, so the key also needscontent:forms:publish(or a master above it); sendaposMode=draftto change only the draft. A signed-in person may call it as far as their own permissions allow; anyone else gets 403. - Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with
Retry-After. The client waits and retries for you; you seeRateLimitedonly if that runs out. - Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
- Timeout: 15 s per attempt by default; raise
timeoutinconfig/fetchski-attract.phpfor longer.
Test it
It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it astests/Feature/CreateFormTest.php, then run your tests:
tests/Feature/CreateFormTest.php
<?php
declare(strict_types=1);
namespace Tests\Feature;
use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
final class CreateFormTest extends TestCase
{
use RefreshDatabase;
public function test_create_form(): void
{
Attract::fake();
$this->actingAs(User::factory()->create())
->postJson('/form')
->assertOk();
Attract::assertCalled('forms.createForm');
}
}
Terminal
php artisan test
forms.createForm with Form::factory()->make([...]), the fields you give over a valid example.
tests/Feature/CreateFormAnswerTest.php
<?php
declare(strict_types=1);
namespace Tests\Feature;
use Fetchski\AttractCmsLaravel\Data\Form;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;
final class CreateFormAnswerTest extends TestCase
{
public function test_create_form_answers_your_values(): void
{
Attract::fake([
'forms.createForm' => Form::factory()->make(['title' => 'Your value']),
]);
$form = Attract::forms()->createForm(title: 'Example title', visibility: 'public', email: 'jo@acme.example');
$this->assertSame('Your value', $form->title);
}
}
Related
List a form’s locales
Attract::forms()->getFormLocales()List forms
Attract::forms()->listForms()Get a form
Attract::forms()->getForm()Replace a form
Attract::forms()->replaceForm()Delete a form
Attract::forms()->deleteForm()Update a form
Attract::forms()->updateForm()POST /@apostrophecms/form
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.