DOCS

v1.3.28
 // Pro v1.2.20

 · Latest

Docs/Extending Order Daemon/Built-in Component Catalog

Built-in Component Catalog

All component IDs shipped with Order Daemon Core and Pro. Use these when writing rules programmatically (CLI, API, tests) or when checking what’s available before building a custom component.

IDs are stable. They match the get_id() return value of each class.

Triggers

Triggers define when a rule fires.

IDLabelTierSource
order_processingOrder ProcessingFreeCore
any_status_changeAny Status ChangeProPro
order_createdOrder CreatedProPro
order_on_holdOrder On HoldProPro
payment_completePayment CompleteProPro
subscription_renewalSubscription RenewalProPro

Conditions

Conditions are evaluated after the trigger fires. All conditions in a rule must pass for the rule to continue.

IDLabelTierSource
order_total_amountOrder Total AmountFreeCore
product_categoryProduct CategoryFreeCore
product_typeProduct TypeFreeCore
event_typeEvent TypeProPro
source_gatewaySource GatewayProPro
timing_conditionTimingProPro

Actions

Actions execute when all conditions pass.

IDLabelTierSource
change_status_to_completedChange Status to CompletedFreeCore
add_order_noteAdd Order NoteProPro
change_status_to_on_holdChange Status to On HoldProPro
change_status_to_processingChange Status to ProcessingProPro
send_emailSend EmailProPro

Using IDs programmatically

When creating rules via REST API or CLI, reference components by their string ID:

{
  "trigger": { "id": "order_processing", "settings": {} },
  "conditions": [
    { "id": "order_total_amount", "settings": { "min": 50, "max": null } },
    { "id": "product_category", "settings": { "category_ids": [12, 34] } }
  ],
  "primaryAction": { "id": "change_status_to_completed", "settings": {} },
  "secondaryActions": []
}

Saving a rule with premium component IDs returns a 403 from the REST API if Pro is not active.

Keeping this catalog current

This table is generated from extracted-symbols.json which is produced by:

npm run extract-symbols

Run this after updating the plugin source to regenerate the catalog data. Then update this page to reflect any additions or removals.

What’s next