> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Alert POST https://forms/%7Bform_id%7D/alerts Content-Type: multipart/form-data Validation rules: - name: required|string|max:255 - event: sometimes|in:submitted,amended - recipients: required|array|min:1 - recipients.*.type: required|in:email,user_id,role - recipients.*.value: required (email must be valid; user_id must be a UUID; role non-empty string) - include_form_data/include_link/is_active: boolean - conditions: nullable object - conditions[business_unit_ids][]: array — each value must be a UUID that exists in tenant_locations for this tenant - conditions[work_order_ids][]: array — each value must be a UUID that exists in work_orders for this tenant - conditions[priority]: nullable string — match work order priority - conditions[tags][]: array of strings — match job type tags Reference: https://docs.itspropel.com/propel-biz/33-forms/07-alerts/create-alert ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /forms/%7Bform_id%7D/alerts: post: operationId: create-alert summary: Create Alert description: >- Validation rules: - name: required|string|max:255 - event: sometimes|in:submitted,amended - recipients: required|array|min:1 - recipients.*.type: required|in:email,user_id,role - recipients.*.value: required (email must be valid; user_id must be a UUID; role non-empty string) - include_form_data/include_link/is_active: boolean - conditions: nullable object - conditions[business_unit_ids][]: array — each value must be a UUID that exists in tenant_locations for this tenant - conditions[work_order_ids][]: array — each value must be a UUID that exists in work_orders for this tenant - conditions[priority]: nullable string — match work order priority - conditions[tags][]: array of strings — match job type tags tags: - subpackage_33Forms.subpackage_33Forms/07Alerts parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/33 Forms_07 Alerts_Create Alert_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: name: type: string description: 'Required: string, max:255 - Alert name' event: type: string description: 'Optional: enum(submitted|amended) - Alert event' is_active: type: string description: 'Optional: boolean - Alert active state' include_link: type: string description: 'Optional: boolean - Include submission link' include_form_data: type: string description: 'Optional: boolean - Include form data in alert' recipients[0][type]: type: string description: 'Required: enum(email|user_id|role) - Recipient type' recipients[0][value]: type: string description: >- Value depends on type: email address if type=email, UUID if type=user_id, role name if type=role required: - name - event - is_active - include_link - include_form_data - recipients[0][type] - recipients[0][value] servers: - url: https:/ components: schemas: 33 Forms_07 Alerts_Create Alert_Response_200: type: object properties: {} description: Empty response body title: 33 Forms_07 Alerts_Create Alert_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/forms/%7Bform_id%7D/alerts" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Work Order Alert\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"event\"\r\n\r\nsubmitted\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_link\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_form_data\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][type]\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][value]\"\r\n\r\nalerts@example.com\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/forms/%7Bform_id%7D/alerts'; const form = new FormData(); form.append('name', 'New Work Order Alert'); form.append('event', 'submitted'); form.append('is_active', 'true'); form.append('include_link', 'false'); form.append('include_form_data', 'true'); form.append('recipients[0][type]', 'email'); form.append('recipients[0][value]', 'alerts@example.com'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/forms/%7Bform_id%7D/alerts" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Work Order Alert\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"event\"\r\n\r\nsubmitted\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_link\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_form_data\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][type]\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][value]\"\r\n\r\nalerts@example.com\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/forms/%7Bform_id%7D/alerts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Work Order Alert\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"event\"\r\n\r\nsubmitted\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_link\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_form_data\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][type]\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][value]\"\r\n\r\nalerts@example.com\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/forms/%7Bform_id%7D/alerts") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Work Order Alert\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"event\"\r\n\r\nsubmitted\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_link\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_form_data\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][type]\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][value]\"\r\n\r\nalerts@example.com\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/forms/%7Bform_id%7D/alerts', [ 'multipart' => [ [ 'name' => 'name', 'contents' => 'New Work Order Alert' ], [ 'name' => 'event', 'contents' => 'submitted' ], [ 'name' => 'is_active', 'contents' => 'true' ], [ 'name' => 'include_link', 'contents' => 'false' ], [ 'name' => 'include_form_data', 'contents' => 'true' ], [ 'name' => 'recipients[0][type]', 'contents' => 'email' ], [ 'name' => 'recipients[0][value]', 'contents' => 'alerts@example.com' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/forms/%7Bform_id%7D/alerts"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nNew Work Order Alert\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"event\"\r\n\r\nsubmitted\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_active\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_link\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_form_data\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][type]\"\r\n\r\nemail\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients[0][value]\"\r\n\r\nalerts@example.com\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "name", "value": "New Work Order Alert" ], [ "name": "event", "value": "submitted" ], [ "name": "is_active", "value": "true" ], [ "name": "include_link", "value": "false" ], [ "name": "include_form_data", "value": "true" ], [ "name": "recipients[0][type]", "value": "email" ], [ "name": "recipients[0][value]", "value": "alerts@example.com" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/forms/%7Bform_id%7D/alerts")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```