Create or update a custom notification
POST /walk-creator/v1/custom-notifications
Operation id: saveCustomNotification
Description
Creates or updates a custom notification (MODEL_POST_ACT_HEADER / MODEL_POST_ACT_DETAILS).
Mirrors legacy POST /api/v2/logic/saveCustomNotification. Presence of post_action_id selects update; omission selects create (new ids are minted server-side).
Authentication: X-reflexis-csrf-token-X required.
Tags: WalkCreatorCustomNotifications
Security
- ApiKeyHeader (apiKey)
- APIGEE API key header validated by VerifyAPIKey policy.
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store. Required on every request. Absence returns HTTP 400; invalid/expired token returns HTTP 401.
Responses
200 — Success — returns custom_notification payload.
Application-level failures may also return HTTP 200 with status: ER.
Content type: application/json
400 — Invalid or missing required request parameter.
Content type: application/json
401 — Missing or invalid X-reflexis-csrf-token-X session token.
Content type: application/json
500 — Unexpected server-side error.
Content type: application/json
Request body
Required: Yes
application/x-www-form-urlencoded
Schema
| Property | Type | Required | Description |
|---|---|---|---|
model_id | string | Yes | |
rule_id | string | No | Logic rule scope; defaults to upon-completion (-1) when omitted. |
post_action_id | string | No | When present, updates the existing row; when absent, creates a new row. |
action_name | string | Yes | URL-encoded action name. |
message_type | string | Yes | |
disposition_type | string | No | |
category | string | No | |
parameters | string | No | URL-encoded JSON object string for notification parameters. |
rule_name | string | No | Optional display name for the post-action header on create. |
{
"type": "object",
"required": [
"model_id",
"action_name",
"message_type"
],
"properties": {
"model_id": {
"type": "string"
},
"rule_id": {
"type": "string",
"description": "Logic rule scope; defaults to upon-completion (`-1`) when omitted."
},
"post_action_id": {
"type": "string",
"description": "When present, updates the existing row; when absent, creates a new row."
},
"action_name": {
"type": "string",
"description": "URL-encoded action name."
},
"message_type": {
"type": "string"
},
"disposition_type": {
"type": "string",
"default": "EVENT_MSG"
},
"category": {
"type": "string"
},
"parameters": {
"type": "string",
"description": "URL-encoded JSON object string for notification parameters."
},
"rule_name": {
"type": "string",
"description": "Optional display name for the post-action header on create."
}
}
}
Response models
200 — Success — returns custom_notification payload.
Application-level failures may also return HTTP 200 with status: ER.
Content type: application/json
Schema
{
"oneOf": [
{
"type": "object",
"required": [
"status",
"custom_notification"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK"
]
},
"custom_notification": {
"type": "object",
"description": "Save/update result. Only fields that add context beyond `post_act_details` are included\nat the top level — `domain_id`, `model_id`, `post_action_id`, and `sequence_no` are\navailable inside `post_act_details` and are not duplicated here.\n",
"required": [
"rule_id",
"post_act_header_rule_id",
"is_update"
],
"properties": {
"rule_id": {
"type": "string",
"description": "The rule scope requested by the caller (`-1` for upon-completion)."
},
"post_act_header_rule_id": {
"type": "string",
"description": "The rule id stored on the `MODEL_POST_ACT_HEADER` row (may differ from `rule_id` for the default scope)."
},
"is_update": {
"type": "boolean",
"description": "`true` when an existing row was updated; `false` for a newly created row."
},
"post_act_details": {
"type": "object",
"description": "Custom notification detail row from `MODEL_POST_ACT_DETAILS`.\nResponse keys use **snake_case** (next-gen convention).\n",
"properties": {
"domain_id": {
"type": "integer"
},
"model_id": {
"type": "string"
},
"rule_id": {
"type": "string"
},
"post_action_id": {
"type": "integer"
},
"sequence_no": {
"type": "integer"
},
"action_name": {
"type": "string"
},
"message_type": {
"type": "string"
},
"disposition_type": {
"type": "string"
},
"category": {
"type": "string"
},
"parameters": {
"type": "object"
},
"created_by": {
"type": "string"
},
"creation_time": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
]
}
400 — Invalid or missing required request parameter.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
Example:
{
"status": "ER",
"errorCode": "E110",
"response": "model_id is mandatory"
}
401 — Missing or invalid X-reflexis-csrf-token-X session token.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
500 — Unexpected server-side error.
Content type: application/json
Schema
Error envelope shape depends on how the error is produced:
- HTTP 200 — business or validation failure after the request is accepted:
{ "status": "ER", "error": "<string or JSON>" }(noerrorCode). - HTTP 4xx/5xx — structured API error:
{ "status": "ER", "errorCode": "<code>", "response": "<localized message>" }.
| Property | Type | Required | Description |
|---|---|---|---|
status | string | No | |
errorCode | string | No | Structured error code for HTTP 4xx/5xx responses. |
response | string | No | Human-readable message when errorCode is present (HTTP 4xx/5xx responses). |
error | oneOf | No | Payload for HTTP 200 error bodies (string, array, or object). |
{
"type": "object",
"description": "Error envelope shape depends on how the error is produced:\n\n- **HTTP 200** — business or validation failure after the request is accepted:\n `{ \"status\": \"ER\", \"error\": \"<string or JSON>\" }` (no `errorCode`).\n- **HTTP 4xx/5xx** — structured API error:\n `{ \"status\": \"ER\", \"errorCode\": \"<code>\", \"response\": \"<localized message>\" }`.\n",
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Structured error code for HTTP 4xx/5xx responses."
},
"response": {
"type": "string",
"description": "Human-readable message when `errorCode` is present (HTTP 4xx/5xx responses)."
},
"error": {
"description": "Payload for HTTP 200 error bodies (string, array, or object).",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {}
},
{
"type": "object"
}
]
}
}
}
Example:
{
"status": "ER",
"errorCode": "E500",
"response": "Unexpected server error."
}