Important Concepts
Target Schema
Target schemas follow JSON Schema format. Other important notes:
- Provide a description for each target property in the
description
property. - Designate required fields in the
required
property.
Periods (e.g. .
) are a reserved character for property names in Lume’s API.
Thus, only property names that do not contain the .
character will be
accepted.
Full Target Schema Example
{
"type": "object",
"properties": {
"full_name": {
"type": ["string"],
"description": "The full name of the customer, including first name and last name."
},
"email_address": {
"type": ["string"],
"description": "The customer's primary email address used for communication.",
"format": "email"
},
"customer_id": {
"type": ["string"],
"description": "Unique identifier for the customer in our system.",
"isPrimaryKey": true,
"format": "uuid"
},
"phone_number": {
"type": ["string"],
"description": "The customer's primary phone number.",
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"subscription_tier": {
"type": ["string"],
"description": "The customer's current subscription tier.",
"enum": ["free", "basic", "premium", "enterprise"],
},
"registration_date": {
"type": ["string"],
"description": "The date when the customer registered for the service.",
"format": "date"
},
"receipt_number": {
"type": ["string"],
"description": "The numeric part of the receipt ID.",
"cleaning_instructions": "Extract only the numeric portion from the receipt ID. For example, from 'REC-12345', extract '12345'."
}
},
"required": [
"full_name",
"email_address",
"customer_id",
"phone_number",
"subscription_tier",
"registration_date",
"receipt_number"
]
}
To learn how to edit target schemas in existing pipelines, see Editing Target Schema.