Trigger types

Property description

The trigger asset configures what activates an automation rule. This article

In-app and user actions (such as creating or modifying an object) or
For scheduled event (specifying when and how often the rule should run), see Triggers (automation).

Minimal JSON: Trigger

{
  "key": "",
  "type": "",
  "": [
    ""
  ]
}

{
  "key": "attribute_changed",
  "type": "attributeChanged",
  "attributeTypeKeys": [
    "core_summary",
    "core_description"
  ]
},
{
  "key": "work\uFB02ow_state_changed",
  "type": "workflowStateChanged",
  "work\uFB02owStateKeys": [
    "core_draft"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	Type of the trigger.	string	Yes
	Keys of the changed properties. The second mandatory property depends on the selected trigger type.	array of strings	Yes

Supported type values

anonymousConceptCreated

An anonymous concept of the specified object type(s) was created.

{
  "key": "",
  "type": "anonymousConceptCreated",
  "objectTypeKeys": []
}

{
  "key": "anonymous_concept_created",
  "type": "anonymousConceptCreated",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	anonymousConceptCreated	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

anonymousConceptPublished

An anonymous concept of the specified object type(s) was published.

{
  "key": "",
  "type": "anonymousConceptPublished",
  "objectTypeKeys": []
}

{
  "key": "anonymous_concept_published",
  "type": "anonymousConceptPublished",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	anonymousConceptPublished	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

attributeChanged

Specified attribute type(s) were changed.

{
  "key": "",
  "type": "attributeChanged",
  "attributeTypeKeys": []
}

{
  "key": "attribute_changed",
  "type": "attributeChanged",
  "attributeTypeKeys": [
    "core_definition"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	attributeChanged	string	Yes
`attributeTypeKeys`	Keys of the attribute types for which the trigger is applicable.	array of strings	Yes

automationFinished

Specified automation rule(s) finished running.

{
  "key": "",
  "type": "automationFinished",
  "automationKeys": []
}

{
  "key": "automation_finished",
  "type": "automationFinished",
  "automationKeys": [
    "cust_completed_attributes"
  ],
  "useAutomationResultData": true
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	automationFinished	string	Yes
`automationKeys`	Keys of the automation rules for which the trigger is applicable.	array of strings	Yes
`useAutomationResultData`	Indicates whether the data from the finished automation rule will be included in this automation rule.	boolean	No

cloneObjectFinished

Finished object cloning.

{
  "key": "",
  "type": "cloneObjectFinished",
  "applicationKeys": []
}

{
  "key": "clone_object_finished",
  "type": "cloneObjectFinished",
  "applicationKeys": [
    "core_documentation_app"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	cloneObjectFinished	string	Yes
`applicationKeys`	Keys of the application where an object was cloned.	array of strings	Yes

commentAdded

A new comment of specified comment type was added.

{
  "key": "",
  "type": "commentAdded",
  "commentTypeKeys": []
}

{
  "key": "comment_added",
  "type": "commentAdded",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentAdded	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

commentChanged

A comment of specified type was changed.

{
  "key": "",
  "type": "commentChanged",
  "commentTypeKeys": []
}

{
  "key": "comment_changed",
  "type": "commentChanged",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentChanged	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

commentDeleted

A comment of specified type was deleted.

{
  "key": "",
  "type": "commentDeleted",
  "commentTypeKeys": []
}

{
  "key": "comment_deleted",
  "type": "commentDeleted",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentDeleted	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

commentReplyAdded

A new reply of specified comment type was added.

{
  "key": "",
  "type": "commentReplyAdded",
  "commentTypeKeys": []
}

{
  "key": "comment_reply_added",
  "type": "commentReplyAdded",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentReplyAdded	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

commentReplyChanged

A reply of specified comment type was changed.

{
  "key": "",
  "type": "commentReplyChanged",
  "commentTypeKeys": []
}

{
  "key": "comment_reply_changed",
  "type": "commentReplyChanged",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentReplyChanged	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

commentReplyDeleted

A reply of specified comment type was deleted.

{
  "key": "",
  "type": "commentReplyDeleted",
  "commentTypeKeys": []
}

{
  "key": "comment_reply_deleted",
  "type": "commentReplyDeleted",
  "commentTypeKeys": [
    "core_comment"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	commentReplyDeleted	string	Yes
`commentTypeKeys`	Keys of the comment types for which the trigger is applicable.	array of strings	Yes

conceptCreated

A concept for the specified object type(s) was created. The trigger does not include concepts created via automation rules using dynamic expressions.

{
  "key": "",
  "type": "conceptCreated",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

{
  "key": "concept_created",
  "type": "conceptCreated",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	conceptCreated	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

conceptPublished

A concept of the specified object type(s) was published.

{
  "key": "",
  "type": "conceptPublished",
  "objectTypeKeys": []
}

{
  "key": "concept_published",
  "type": "conceptPublished",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	conceptPublished	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

ingestionFinished

Ingestion(s) for specified application(s) finished. Only newly added objects will trigger the automation, ingestion of changes to existing attributes will not trigger it.

{
  "key": "",
  "type": "ingestionFinished",
  "applicationKeys": []
}

{
  "key": "ingestion_finished",
  "type": "ingestionFinished",
  "applicationKeys": [
    "core_documentation"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	ingestionFinished	string	Yes
`applicationKeys`	Keys of the applications for which the trigger is applicable.	array of strings	Yes

objectAdded

Specified object type(s) were added.

{
  "key": "",
  "type": "objectAdded",
  "objectTypeKeys": []
}

{
  "key": "object_added",
  "type": "objectAdded",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	objectAdded	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

objectDeleted

Specified object type(s) were deleted.

{
  "key": "",
  "type": "objectDeleted",
  "objectTypeKeys": []
}

{
  "key": "object_deleted",
  "type": "objectDeleted",
  "objectTypeKeys": [
    "core_documentation_document"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	objectDeleted	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

objectMoved

An object was moved in the hierarchy under a new parent or the sort order was changed.

{
  "key": "",
  "type": "objectMoved"
}

{
  "key": "object_moved",
  "type": "objectMoved",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	objectMoved	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	No

objectRenamed

Specified object type(s) were renamed.

{
  "key": "",
  "type": "objectRenamed",
  "objectTypeKeys": []
}

{
  "key": "object_renamed",
  "type": "objectRenamed",
  "objectTypeKeys": [
    "core_documentation_document_set"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	objectRenamed	string	Yes
`objectTypeKeys`	Keys of the object types for which the trigger is applicable.	array of strings	Yes

relationAdded

Specified object relation(s) were added.

{
  "key": "",
  "type": "relationAdded",
  "relationTypeKeys": []
}

{
  "key": "relation_added",
  "type": "relationAdded",
  "relationTypeKeys": [
    "core_isMentioning"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	relationAdded	string	Yes
`relationTypeKeys`	Keys of the relation types for which the trigger is applicable.	array of strings	Yes

relationDeleted

Specified object relation(s) were deleted.

{
  "key": "",
  "type": "relationDeleted",
  "relationTypeKeys": []
}

{
  "key": "relation_deleted",
  "type": "relationDeleted",
  "relationTypeKeys": [
    "core_isMentioning"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	relationDeleted	string	Yes
`relationTypeKeys`	Keys of the relation types for which the trigger is applicable.	array of strings	Yes

userRelationAdded

Specified user relation(s) were added.

{
  "key": "",
  "type": "userRelationAdded",
  "userRelationTypeKeys": []
}

{
  "key": "user_relation_added",
  "type": "userRelationAdded",
  "userRelationTypeKeys": [
    "core_steward"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	userRelationAdded	string	Yes
`userRelationTypeKeys`	Keys of the user relation types for which the trigger is applicable.	array of strings	Yes

userRelationDeleted

Specified user relation(s) were deleted.

{
  "key": "",
  "type": "userRelationDeleted",
  "userRelationTypeKeys": []
}

{
  "key": "user_relation_deleted",
  "type": "userRelationDeleted",
  "userRelationTypeKeys": [
    "core_steward"
  ]
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	userRelationDeleted	string	Yes
`userRelationTypeKeys`	Keys of the user relation types for which the trigger is applicable.	array of strings	Yes

workflowStateChanged

Workflow state(s) were changed.

{
  "key": "",
  "type": "workflowStateChanged",
  "workflowStateKeys": []
}

{
  "key": "workflow_state_changed",
  "type": "workflowStateChanged",
  "workflowStateKeys": [
    "core_documentation_document_set"
  ],
  "userRelationTypeKeys": [
    "core_steward"
  ],
  "multipleUsersApproval": true
}

Nested properties

Property	Description	Values	Mandatory
`key`	Unique key of the trigger.	string	Yes
`type`	workflowStateChanged	string	Yes
`workflowStateKeys`	Keys of the initial workflow state.	array of strings	Yes
userRelationTypeKeys	Specifies the user relation type in which the user who changed the workflow state is.	array of strings	No
multipleUsersApproval	Used in case of workflows that need multi-user approval. Determines whether the automation runs even if the workflow state was not changed (the workflow change has not been approved by all users).	boolean	No

Property description

Minimal JSON: Trigger

Supported type values

anonymousConceptCreated

anonymousConceptPublished

attributeChanged

automationFinished

cloneObjectFinished

commentAdded

commentChanged

commentDeleted

commentReplyAdded

commentReplyChanged

commentReplyDeleted

conceptCreated

conceptPublished

ingestionFinished

objectAdded

objectDeleted

objectMoved

objectRenamed

relationAdded

relationDeleted

userRelationAdded

userRelationDeleted

workflowStateChanged

We use cookies