OBJECT

ProcessEntity

Automatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook).

link GraphQL Schema definition

  • type ProcessEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # User who owns the process.
  • owner: ClientEntity
  • # AI assistant conversation associated with the process (e.g. records of AI-driven
  • # schema generation).
  • aiConversation: [AiConversationItem!]
  • # Why the process is disabled: turned off by a user, suspended after repeated
  • # failed runs, or suspended because Automatizer was switched off for the space.
  • # NoReason while enabled; read-only.
  • deactivationReason: ProcessDeactivationReasonEnum
  • # Free-text description shown alongside the process.
  • description: String
  • # When true, the process actively responds to its trigger; when false, the process
  • # is paused. Toggle via enable/disable mutations.
  • isEnabled: Boolean
  • # Timestamp of the most recent change to settings.
  • lastSchemaChange: DateTime
  • # Timestamp of the most recent change to isEnabled.
  • lastStatusChange: DateTime
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Process schema as a JSON object conforming to the ProcessSchema type — trigger,
  • # nodes and settings. Built via the process builder; validated on write. Full
  • # structure:
  • # https://api-doc.coevera.com/latest/graphql/space/processschema.doc.html This
  • # payload conforms to the `ProcessSchema` JSON Schema:
  • # https://api-doc.coevera.com/schemas/ProcessSchema.json
  • settings: ProcessSchema
  • # Scope of the process: Personal processes belong to their owner and are started
  • # only by the owner's own actions; Space processes apply to the whole space.
  • type: ProcessTypeEnum!
  • # Activity log runs (one per process execution) recorded for this process.
  • #
  • # Arguments
  • # filter: Filter ProcessActivityLog relations by target
  • # ProcessActivityLog attributes.
  • # orderBy: Order ProcessActivityLog relations by target
  • # ProcessActivityLog attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • activityLogs(
  • filter: ProcessActivityLogFilterInput,
  • orderBy: [ProcessActivityLogOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ProcessActivityLogEntityConnection
  • # Tags attached to the process for organisation/filtering.
  • #
  • # Arguments
  • # filter: Filter Tag relations by target Tag attributes.
  • # filterEdge: Filter TagRelation relations by edge (relation)
  • # TagRelation attributes.
  • # orderBy: Order Tag relations by target Tag attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • tags(
  • filter: TagFilterInput,
  • filterEdge: TagRelationFilterInput,
  • orderBy: [TagOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TagRelationEntityConnection
  • # Timestamp of the most recent execution of this process. Empty when never run.
  • lastProcessRun: DateTime
  • # Solutions whose canvas contains this record. Deleted solutions are not included.
  • #
  • # Arguments
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • solutions(before: String, after: String, first: Int, last: Int): SolutionEntityConnection
  • # Activity timeline for the last 24 hours showing per-hour counts of successful,
  • # warning, and error process runs.
  • activity: ProcessTimelineResult!
  • # Overall status of the process, derived from its most recent runs since it was
  • # last enabled or its settings changed: Ok, Warning or Error. Ok when there are no
  • # runs.
  • status: ProcessStatusEnum
  • # For record-triggered processes, the event that starts the process: Create,
  • # Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for
  • # email-triggered processes. Empty for other trigger types.
  • recordTriggerEvent: ProcessRecordTriggerEventEnum
  • # What starts the process: a record event (ProcessRecordTrigger), a schedule
  • # (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or
  • # an online form submission (ProcessOnlineFormTrigger).
  • triggerType: ProcessTriggerTypeEnum
  • # For record-based triggers, the entity whose records fire the process (e.g.
  • # "Lead"). Empty for non-record triggers.
  • triggerEntityName: EntityNameEnum
  • # API name of the trigger entity (useful for custom entities where this differs
  • # from triggerEntityName). Empty for non-record triggers.
  • triggerEntityApiName: String
  • # Files attached to the process (e.g. process documentation).
  • documents: [CloudObjectRelationEntity!]
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }