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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # User who owns the process.
- : ClientEntity
- # AI assistant conversation associated with the process (e.g. records of AI-driven
- # schema generation).
- : [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.
- : ProcessDeactivationReasonEnum
- # Free-text description shown alongside the process.
- : String
- # When true, the process actively responds to its trigger; when false, the process
- # is paused. Toggle via enable/disable mutations.
- : Boolean
- # Timestamp of the most recent change to settings.
- : DateTime
- # Timestamp of the most recent change to isEnabled.
- : DateTime
- # Name of the entity and its default text representation.
- : String!
- # Id of the owning user.
- : 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
- : 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.
- : 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.
- (
- : ProcessActivityLogFilterInput,
- : [ProcessActivityLogOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : 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.
- (
- : TagFilterInput,
- : TagRelationFilterInput,
- : [TagOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): TagRelationEntityConnection
- # Timestamp of the most recent execution of this process. Empty when never run.
- : 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.
- (: String, : String, : Int, : Int): SolutionEntityConnection
- # Activity timeline for the last 24 hours showing per-hour counts of successful,
- # warning, and error process runs.
- : 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.
- : 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.
- : ProcessRecordTriggerEventEnum
- # What starts the process: a record event (ProcessRecordTrigger), a schedule
- # (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or
- # an online form submission (ProcessOnlineFormTrigger).
- : ProcessTriggerTypeEnum
- # For record-based triggers, the entity whose records fire the process (e.g.
- # "Lead"). Empty for non-record triggers.
- : EntityNameEnum
- # API name of the trigger entity (useful for custom entities where this differs
- # from triggerEntityName). Empty for non-record triggers.
- : String
- # Files attached to the process (e.g. process documentation).
- : [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.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateProcessFromTemplatePayloadResult of the createProcessFromTemplate mutation.
- CreateProcessPayloadResult of the createProcess mutation.
- DeleteProcessPayloadResult of the deleteProcess mutation.
- ProcessActivityLogEntityOne run of an Automatizer process, with its status, timing and the steps it took.
- ProcessEntityEdgeA Relay edge containing a `ProcessEntity` and its cursor.
- ProcessRepositoryRead operations for Process records.
- ProcessScheduledActionEntityAction of an Automatizer process that is waiting to run for a record at a scheduled time.
- StepChecklistEntityChecklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
- TagRelationEntityAssignment of a tag to a record.
- UpdateProcessPayloadResult of the updateProcess mutation.