V3WebformsCreateOrUpdateWebformRequest

Public API request for creating a webform

Example Usage

import { V3WebformsCreateOrUpdateWebformRequest } from "@solarwinds/squadcast-sdk-typescript/models";

let value: V3WebformsCreateOrUpdateWebformRequest = {
  ownerId: "<id>",
  name: "<value>",
  isCname: true,
  isCaptchaEnabled: true,
  captchaSecret: {
    siteKey: "<value>",
    secret: "<value>",
  },
  formOwnerType: "<value>",
  formOwnerId: "<id>",
  services: [],
  header: "<value>",
  title: "<value>",
  footerText: "<value>",
  footerLink: "<value>",
};

Fields

Field	Type	Required	Description
ownerId	string	✔️	Unique identifier of the owner (string or UUID)
name	string	✔️	Name of the webform
isCname	boolean	✔️	Indicates if a custom domain (CNAME) is used
hostName	string	➖	Custom hostname if CNAME is enabled
tags	models.V3WebformsCreateOrUpdateWebformRequestTags	➖	Key-value tags for the webform
isCaptchaEnabled	boolean	✔️	Whether CAPTCHA is enabled on the form
captchaSecret	models.V3WebformsRecaptchaSecrets	✔️	CAPTCHA credentials to be validated
formOwnerType	string	✔️	Entity type that owns the form (e.g., team, user)
formOwnerId	string	✔️	Identifier for the owner entity
services	models.V3WebformsWFService[]	✔️	List of services tied to this webform
inputField	models.V3WebformsWFInputField[]	➖	Input fields to be rendered on the form
header	string	✔️	Header text shown on the form
title	string	✔️	Title of the webform
logoUrl	string	➖	URL to the organization's logo
footerText	string	✔️	Text displayed in the footer
footerLink	string	✔️	Hyperlink in the footer (mailto or https)
emailOn	string[]	➖	Emails to notify on submission
description	string	➖	Optional description for the webform