Rules

Last updated 4 months ago

Rules allow you to react to events in your app and to synchronize contents and assets with other systems.

A rule has two elements:

  1. Trigger: Define when a rule is executed, for example when a content is created.

  2. Action: Defines what will be executed when the rule is triggered.

Almost all text settings for actions support placeholder. At the moment the following placehold are supported:

  • $APP_ID: The id of your app (guid).

  • $APP_NAME: The name of your app.

  • $USER_NAME: The display name of the user (or client name).

  • $USER_EMAIL: The email address of the user (or client name).

  • $TIMESTAMP_DATE: The date when the event has happened (usually different from the time when the rule is executed) in the following format: yyyy-MM-dd.

  • $TIMESTAMP_DATETIME; The date when the event has happened (usually different from the time when the rule is executed) in the following format: yyyy-MM-dd-hh-mm-ss.

For ContentChangedTrigger:

  • $SCHEMA_ID: The id of the schema.

  • $SCHEMA_NAME: The name of the schema.

  • $CONTENT_URL: The url to the content in the administration tool.

  • $CONTENT_ACTION: The content event (created, updated, deleted).

Squidex will make several attempts to execute an rule:

  1. After a few seconds.

  2. After 5 minutes

  3. After 1 hour.

  4. After 6 hours.

  5. After 12 hours.

A rule execution will be treated as failed if it does not complete successfully within 2 seconds If your target system is slow (e.g. a webhook) you should use an queue between Squidex and your application.

Rule executions will be stored as events for 2 days for debugging and will be deleted automatically.