create_notification

Create an application notification.

channel is email (settings: optional from_address) or push (settings: required path, an absolute in-app path such as /orders/{{order.id}}, optional collapse_key of at most 64 characters and nonnegative integer badge). Push needs the application’s mobile_distribution capability enabled; its recipients are identity records named by recipient_config {"type": "static", "record_ids": [...]} or {"type": "field", "field": "<context key holding record ids>"}.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "body_template": {
      "title": "Body Template",
      "type": "string"
    },
    "channel": {
      "default": "email",
      "title": "Channel",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "is_active": {
      "default": true,
      "title": "Is Active",
      "type": "boolean"
    },
    "model_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Model Id"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "recipient_config": {
      "additionalProperties": true,
      "title": "Recipient Config",
      "type": "object"
    },
    "settings": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    },
    "subject_template": {
      "title": "Subject Template",
      "type": "string"
    },
    "trigger_events": {
      "items": {
        "type": "string"
      },
      "title": "Trigger Events",
      "type": "array"
    }
  },
  "required": [
    "application_id",
    "name",
    "subject_template",
    "body_template",
    "recipient_config",
    "trigger_events"
  ],
  "title": "create_notificationArguments",
  "type": "object"
}

Output schema

{
  "properties": {
    "applicationId": {
      "format": "uuid",
      "title": "Applicationid",
      "type": "string"
    },
    "bodyTemplate": {
      "title": "Bodytemplate",
      "type": "string"
    },
    "channel": {
      "enum": [
        "email",
        "push"
      ],
      "title": "NotificationChannel",
      "type": "string"
    },
    "createdAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Createdat"
    },
    "createdBy": {
      "format": "uuid",
      "title": "Createdby",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "isActive": {
      "title": "Isactive",
      "type": "boolean"
    },
    "modelId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Modelid"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "recipientConfig": {
      "additionalProperties": true,
      "title": "Recipientconfig",
      "type": "object"
    },
    "settings": {
      "additionalProperties": true,
      "title": "Settings",
      "type": "object"
    },
    "subjectTemplate": {
      "title": "Subjecttemplate",
      "type": "string"
    },
    "triggerEvents": {
      "items": {
        "type": "string"
      },
      "title": "Triggerevents",
      "type": "array"
    },
    "updatedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updatedat"
    }
  },
  "required": [
    "id",
    "applicationId",
    "name",
    "channel",
    "subjectTemplate",
    "bodyTemplate",
    "recipientConfig",
    "triggerEvents",
    "isActive",
    "settings",
    "createdBy"
  ],
  "title": "PublicNotificationResponse",
  "type": "object"
}