Create Alert

View as Markdown
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

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
namestringRequired

Required: string, max:255 - Alert name

eventstringRequired

Optional: enum(submitted|amended) - Alert event

is_activestringRequired

Optional: boolean - Alert active state

include_form_datastringRequired

Optional: boolean - Include form data in alert

recipients[0][type]stringRequired

Required: enum(email|user_id|role) - Recipient type

recipients[0][value]stringRequired

Value depends on type: email address if type=email, UUID if type=user_id, role name if type=role

Response

Successful response