# Webforms ## Get All Webforms > Returns all webforms of the given \`owner\_id\` (teamId) in the request param.\ > Requires \`access\_token\` as a \`Bearer {{token}}\` in the \`Authorization\` header with \`read\` scope. ```json {"openapi":"3.1.0","info":{"title":"Squadcast","version":"1.0.0"},"tags":[{"name":"Webforms"}],"servers":[{"url":"https://api.squadcast.com","description":"production US env","variables":{}},{"url":"https://api.eu.squadcast.com","description":"production EU env","variables":{}}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"V3.Webforms.WebformResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/V3.Webforms.Webform"}]},"V3.Webforms.Webform":{"type":"object","required":["id","org_id","owner_id","name","is_cname","public_url","tags","is_captcha_enabled","captcha_provider","captcha_secret","form_owner_type","form_owner_id","form_owner_name","services","input_field","header","title","footer_text","footer_link","email_on","incident_count","mttr","is_deleted","deleted_at"],"properties":{"id":{"type":"integer","format":"int32"},"org_id":{"type":"string"},"owner_id":{"type":"string"},"name":{"type":"string"},"is_cname":{"type":"boolean"},"public_url":{"type":"string"},"host_name":{"type":"string"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"}},"is_captcha_enabled":{"type":"boolean"},"captcha_provider":{"type":"string"},"captcha_secret":{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"},"form_owner_type":{"type":"string"},"form_owner_id":{"type":"string"},"form_owner_name":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"}},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"}},"header":{"type":"string"},"title":{"type":"string"},"logo_url":{"type":"string"},"footer_text":{"type":"string"},"footer_link":{"type":"string"},"email_on":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"incident_count":{"type":"integer","format":"int64"},"mttr":{"type":"number","format":"double"},"is_deleted":{"type":"boolean"},"deleted_at":{"type":"string"}}},"V3.Webforms.RecaptchaSecrets":{"type":"object","required":["site_key","secret"],"properties":{"site_key":{"type":"string","description":"reCAPTCHA site key"},"secret":{"type":"string","description":"reCAPTCHA secret key"}},"description":"reCAPTCHA credentials to be validated"},"V3.Webforms.WFService":{"type":"object","required":["service_id","name","alias"],"properties":{"service_id":{"type":"string","description":"Public identifier for the service"},"name":{"type":"string","description":"Service name as shown in UI"},"alias":{"type":"string","description":"Optional alias for the service"}},"description":"Service details for a webform"},"V3.Webforms.WFInputField":{"type":"object","required":["label","options"],"properties":{"label":{"type":"string","description":"Field label"},"options":{"type":"array","items":{"type":"string"},"description":"Selectable options for this field"}},"description":"Input field definition for a webform"},"Common.V3.ErrorMeta":{"type":"object","required":["status","error_message"],"properties":{"status":{"anyOf":[{"type":"string"},{"type":"integer"}]},"error_message":{"type":"string"}},"description":"Represents a single response containing data of type T."}}},"paths":{"/v3/webform":{"get":{"operationId":"Webforms_getAllWebforms","summary":"Get All Webforms","description":"Returns all webforms of the given `owner_id` (teamId) in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope.","parameters":[{"name":"owner_id","in":"query","required":true,"schema":{"type":"string"},"explode":false},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WebformResponse"}},"meta":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32"}},"required":["total_count"]}},"required":["data","meta"]}}}},"400":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"401":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"402":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"403":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"422":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"502":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"504":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}}},"tags":["Webforms"]}}}} ``` ## Create Webform > Add a webform to the organization. Returns the webform object in response.\ > Requires \`access\_token\` as a \`Bearer {{token}}\` in the \`Authorization\` header with \`user-write\` scope. ```json {"openapi":"3.1.0","info":{"title":"Squadcast","version":"1.0.0"},"tags":[{"name":"Webforms"}],"servers":[{"url":"https://api.squadcast.com","description":"production US env","variables":{}},{"url":"https://api.eu.squadcast.com","description":"production EU env","variables":{}}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"V3.Webforms.WebformResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/V3.Webforms.Webform"}]},"V3.Webforms.Webform":{"type":"object","required":["id","org_id","owner_id","name","is_cname","public_url","tags","is_captcha_enabled","captcha_provider","captcha_secret","form_owner_type","form_owner_id","form_owner_name","services","input_field","header","title","footer_text","footer_link","email_on","incident_count","mttr","is_deleted","deleted_at"],"properties":{"id":{"type":"integer","format":"int32"},"org_id":{"type":"string"},"owner_id":{"type":"string"},"name":{"type":"string"},"is_cname":{"type":"boolean"},"public_url":{"type":"string"},"host_name":{"type":"string"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"}},"is_captcha_enabled":{"type":"boolean"},"captcha_provider":{"type":"string"},"captcha_secret":{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"},"form_owner_type":{"type":"string"},"form_owner_id":{"type":"string"},"form_owner_name":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"}},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"}},"header":{"type":"string"},"title":{"type":"string"},"logo_url":{"type":"string"},"footer_text":{"type":"string"},"footer_link":{"type":"string"},"email_on":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"incident_count":{"type":"integer","format":"int64"},"mttr":{"type":"number","format":"double"},"is_deleted":{"type":"boolean"},"deleted_at":{"type":"string"}}},"V3.Webforms.RecaptchaSecrets":{"type":"object","required":["site_key","secret"],"properties":{"site_key":{"type":"string","description":"reCAPTCHA site key"},"secret":{"type":"string","description":"reCAPTCHA secret key"}},"description":"reCAPTCHA credentials to be validated"},"V3.Webforms.WFService":{"type":"object","required":["service_id","name","alias"],"properties":{"service_id":{"type":"string","description":"Public identifier for the service"},"name":{"type":"string","description":"Service name as shown in UI"},"alias":{"type":"string","description":"Optional alias for the service"}},"description":"Service details for a webform"},"V3.Webforms.WFInputField":{"type":"object","required":["label","options"],"properties":{"label":{"type":"string","description":"Field label"},"options":{"type":"array","items":{"type":"string"},"description":"Selectable options for this field"}},"description":"Input field definition for a webform"},"Common.V3.ErrorMeta":{"type":"object","required":["status","error_message"],"properties":{"status":{"anyOf":[{"type":"string"},{"type":"integer"}]},"error_message":{"type":"string"}},"description":"Represents a single response containing data of type T."},"V3.Webforms.CreateOrUpdateWebformRequest":{"type":"object","required":["owner_id","name","is_cname","is_captcha_enabled","captcha_secret","form_owner_type","form_owner_id","services","header","title","footer_text","footer_link"],"properties":{"owner_id":{"type":"string","description":"Unique identifier of the owner (string or UUID)"},"name":{"type":"string","description":"Name of the webform"},"is_cname":{"type":"boolean","description":"Indicates if a custom domain (CNAME) is used"},"host_name":{"type":"string","description":"Custom hostname if CNAME is enabled"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"},"description":"Key-value tags for the webform"},"is_captcha_enabled":{"type":"boolean","description":"Whether CAPTCHA is enabled on the form"},"captcha_secret":{"allOf":[{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"}],"description":"CAPTCHA credentials to be validated"},"form_owner_type":{"type":"string","description":"Entity type that owns the form (e.g., team, user)"},"form_owner_id":{"type":"string","description":"Identifier for the owner entity"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"},"description":"List of services tied to this webform"},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"},"description":"Input fields to be rendered on the form"},"header":{"type":"string","description":"Header text shown on the form"},"title":{"type":"string","description":"Title of the webform"},"logo_url":{"type":"string","description":"URL to the organization's logo"},"footer_text":{"type":"string","description":"Text displayed in the footer"},"footer_link":{"type":"string","description":"Hyperlink in the footer (mailto or https)"},"email_on":{"type":"array","items":{"type":"string"},"description":"Emails to notify on submission"},"description":{"type":"string","description":"Optional description for the webform"}},"description":"Public API request for creating a webform"}}},"paths":{"/v3/webform":{"post":{"operationId":"Webforms_createWebform","summary":"Create Webform","description":"Add a webform to the organization. Returns the webform object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope.","parameters":[],"responses":{"201":{"description":"The request has succeeded and a new resource has been created as a result.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"webform":{"$ref":"#/components/schemas/V3.Webforms.WebformResponse"}},"required":["webform"]}},"required":["data"]}}}},"400":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"401":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"402":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"403":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"422":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"502":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"504":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}}},"tags":["Webforms"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3.Webforms.CreateOrUpdateWebformRequest"}}}}}}}} ``` ## Get Webform By ID > Returns a webform details of the given \`webformId\` in the request param.\ > Requires \`access\_token\` as a \`Bearer {{token}}\` in the \`Authorization\` header with \`read\` scope. ```json {"openapi":"3.1.0","info":{"title":"Squadcast","version":"1.0.0"},"tags":[{"name":"Webforms"}],"servers":[{"url":"https://api.squadcast.com","description":"production US env","variables":{}},{"url":"https://api.eu.squadcast.com","description":"production EU env","variables":{}}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"V3.Webforms.WebformResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/V3.Webforms.Webform"}]},"V3.Webforms.Webform":{"type":"object","required":["id","org_id","owner_id","name","is_cname","public_url","tags","is_captcha_enabled","captcha_provider","captcha_secret","form_owner_type","form_owner_id","form_owner_name","services","input_field","header","title","footer_text","footer_link","email_on","incident_count","mttr","is_deleted","deleted_at"],"properties":{"id":{"type":"integer","format":"int32"},"org_id":{"type":"string"},"owner_id":{"type":"string"},"name":{"type":"string"},"is_cname":{"type":"boolean"},"public_url":{"type":"string"},"host_name":{"type":"string"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"}},"is_captcha_enabled":{"type":"boolean"},"captcha_provider":{"type":"string"},"captcha_secret":{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"},"form_owner_type":{"type":"string"},"form_owner_id":{"type":"string"},"form_owner_name":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"}},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"}},"header":{"type":"string"},"title":{"type":"string"},"logo_url":{"type":"string"},"footer_text":{"type":"string"},"footer_link":{"type":"string"},"email_on":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"incident_count":{"type":"integer","format":"int64"},"mttr":{"type":"number","format":"double"},"is_deleted":{"type":"boolean"},"deleted_at":{"type":"string"}}},"V3.Webforms.RecaptchaSecrets":{"type":"object","required":["site_key","secret"],"properties":{"site_key":{"type":"string","description":"reCAPTCHA site key"},"secret":{"type":"string","description":"reCAPTCHA secret key"}},"description":"reCAPTCHA credentials to be validated"},"V3.Webforms.WFService":{"type":"object","required":["service_id","name","alias"],"properties":{"service_id":{"type":"string","description":"Public identifier for the service"},"name":{"type":"string","description":"Service name as shown in UI"},"alias":{"type":"string","description":"Optional alias for the service"}},"description":"Service details for a webform"},"V3.Webforms.WFInputField":{"type":"object","required":["label","options"],"properties":{"label":{"type":"string","description":"Field label"},"options":{"type":"array","items":{"type":"string"},"description":"Selectable options for this field"}},"description":"Input field definition for a webform"},"Common.V3.ErrorMeta":{"type":"object","required":["status","error_message"],"properties":{"status":{"anyOf":[{"type":"string"},{"type":"integer"}]},"error_message":{"type":"string"}},"description":"Represents a single response containing data of type T."}}},"paths":{"/v3/webform/{webformId}":{"get":{"operationId":"Webforms_getWebformById","summary":"Get Webform By ID","description":"Returns a webform details of the given `webformId` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope.","parameters":[{"name":"webformId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"owner_id","in":"query","required":true,"schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/V3.Webforms.WebformResponse"}}}}}},"400":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"401":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"402":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"403":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"422":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"502":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"504":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}}},"tags":["Webforms"]}}}} ``` ## Update Webform > Update a webform to the organization. Returns the webform object in response.\ > Requires \`access\_token\` as a \`Bearer {{token}}\` in the \`Authorization\` header with \`user-write\` scope. ```json {"openapi":"3.1.0","info":{"title":"Squadcast","version":"1.0.0"},"tags":[{"name":"Webforms"}],"servers":[{"url":"https://api.squadcast.com","description":"production US env","variables":{}},{"url":"https://api.eu.squadcast.com","description":"production EU env","variables":{}}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"V3.Webforms.WebformResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/V3.Webforms.Webform"}]},"V3.Webforms.Webform":{"type":"object","required":["id","org_id","owner_id","name","is_cname","public_url","tags","is_captcha_enabled","captcha_provider","captcha_secret","form_owner_type","form_owner_id","form_owner_name","services","input_field","header","title","footer_text","footer_link","email_on","incident_count","mttr","is_deleted","deleted_at"],"properties":{"id":{"type":"integer","format":"int32"},"org_id":{"type":"string"},"owner_id":{"type":"string"},"name":{"type":"string"},"is_cname":{"type":"boolean"},"public_url":{"type":"string"},"host_name":{"type":"string"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"}},"is_captcha_enabled":{"type":"boolean"},"captcha_provider":{"type":"string"},"captcha_secret":{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"},"form_owner_type":{"type":"string"},"form_owner_id":{"type":"string"},"form_owner_name":{"type":"string"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"}},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"}},"header":{"type":"string"},"title":{"type":"string"},"logo_url":{"type":"string"},"footer_text":{"type":"string"},"footer_link":{"type":"string"},"email_on":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"incident_count":{"type":"integer","format":"int64"},"mttr":{"type":"number","format":"double"},"is_deleted":{"type":"boolean"},"deleted_at":{"type":"string"}}},"V3.Webforms.RecaptchaSecrets":{"type":"object","required":["site_key","secret"],"properties":{"site_key":{"type":"string","description":"reCAPTCHA site key"},"secret":{"type":"string","description":"reCAPTCHA secret key"}},"description":"reCAPTCHA credentials to be validated"},"V3.Webforms.WFService":{"type":"object","required":["service_id","name","alias"],"properties":{"service_id":{"type":"string","description":"Public identifier for the service"},"name":{"type":"string","description":"Service name as shown in UI"},"alias":{"type":"string","description":"Optional alias for the service"}},"description":"Service details for a webform"},"V3.Webforms.WFInputField":{"type":"object","required":["label","options"],"properties":{"label":{"type":"string","description":"Field label"},"options":{"type":"array","items":{"type":"string"},"description":"Selectable options for this field"}},"description":"Input field definition for a webform"},"Common.V3.ErrorMeta":{"type":"object","required":["status","error_message"],"properties":{"status":{"anyOf":[{"type":"string"},{"type":"integer"}]},"error_message":{"type":"string"}},"description":"Represents a single response containing data of type T."},"V3.Webforms.CreateOrUpdateWebformRequest":{"type":"object","required":["owner_id","name","is_cname","is_captcha_enabled","captcha_secret","form_owner_type","form_owner_id","services","header","title","footer_text","footer_link"],"properties":{"owner_id":{"type":"string","description":"Unique identifier of the owner (string or UUID)"},"name":{"type":"string","description":"Name of the webform"},"is_cname":{"type":"boolean","description":"Indicates if a custom domain (CNAME) is used"},"host_name":{"type":"string","description":"Custom hostname if CNAME is enabled"},"tags":{"type":"object","unevaluatedProperties":{"type":"string"},"description":"Key-value tags for the webform"},"is_captcha_enabled":{"type":"boolean","description":"Whether CAPTCHA is enabled on the form"},"captcha_secret":{"allOf":[{"$ref":"#/components/schemas/V3.Webforms.RecaptchaSecrets"}],"description":"CAPTCHA credentials to be validated"},"form_owner_type":{"type":"string","description":"Entity type that owns the form (e.g., team, user)"},"form_owner_id":{"type":"string","description":"Identifier for the owner entity"},"services":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFService"},"description":"List of services tied to this webform"},"input_field":{"type":"array","items":{"$ref":"#/components/schemas/V3.Webforms.WFInputField"},"description":"Input fields to be rendered on the form"},"header":{"type":"string","description":"Header text shown on the form"},"title":{"type":"string","description":"Title of the webform"},"logo_url":{"type":"string","description":"URL to the organization's logo"},"footer_text":{"type":"string","description":"Text displayed in the footer"},"footer_link":{"type":"string","description":"Hyperlink in the footer (mailto or https)"},"email_on":{"type":"array","items":{"type":"string"},"description":"Emails to notify on submission"},"description":{"type":"string","description":"Optional description for the webform"}},"description":"Public API request for creating a webform"}}},"paths":{"/v3/webform/{webformId}":{"put":{"operationId":"Webforms_updateWebform","summary":"Update Webform","description":"Update a webform to the organization. Returns the webform object in response.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope.","parameters":[{"name":"webformId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/V3.Webforms.WebformResponse"}}}}}},"400":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"401":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"402":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"403":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"422":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"502":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"504":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}}},"tags":["Webforms"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3.Webforms.CreateOrUpdateWebformRequest"}}}}}}}} ``` ## Remove Webform > Remove a webform from the organization.\ > Requires \`access\_token\` as a \`Bearer {{token}}\` in the \`Authorization\` header with \`user-write\` scope. ```json {"openapi":"3.1.0","info":{"title":"Squadcast","version":"1.0.0"},"tags":[{"name":"Webforms"}],"servers":[{"url":"https://api.squadcast.com","description":"production US env","variables":{}},{"url":"https://api.eu.squadcast.com","description":"production EU env","variables":{}}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Common.V3.ErrorMeta":{"type":"object","required":["status","error_message"],"properties":{"status":{"anyOf":[{"type":"string"},{"type":"integer"}]},"error_message":{"type":"string"}},"description":"Represents a single response containing data of type T."}}},"paths":{"/v3/webform/{webformId}":{"delete":{"operationId":"Webforms_removeWebform","summary":"Remove Webform","description":"Remove a webform from the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope.","parameters":[{"name":"webformId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"owner_id","in":"query","required":true,"schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string"}},"required":["data"]}}}},"400":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"401":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"402":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"403":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"422":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"502":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"503":{"description":"Service unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}},"504":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Common.V3.ErrorMeta"}},"required":["meta"]}}}}},"tags":["Webforms"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.incidents.cloud.solarwinds.com/api-reference/webforms.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.