Workflow

Workflow

Flujo automatizado compuesto por pasos conectados.

idstring

Identificador único del workflow.

Example: wf_1B2M2Y8AsgTpgAmY7PhCfg

namestring

Nombre del workflow.

Example: Flujo de revisión legal DSR

descriptionstringnullable

Descripción del workflow.

Example: Orquesta revisión legal y transición de estado

statusstring

Estado de publicación del workflow.

Possible values: [draft, published]

Example: draft

runs_countinteger

Cantidad total de ejecuciones históricas del workflow.

Example: 42

created_by objectnullable

idstring

Identificador único del usuario de empresa que creó el workflow.

Example: cusr_1B2M2Y8AsgTpgAmY7PhCfg

namestring

Nombre del usuario de empresa.

Example: Catalina Sepúlveda

emailstring

Email del usuario de empresa.

Example: catalina@company.com

settings object

failure_alerts object

enabledboolean

Envía un correo cuando una ejecución del workflow termina en estado failed.

Example: false

starting_step_idstringnullable

ID del paso inicial. Debe apuntar a un bloque trigger.

Example: 66f01d4f1d0b5a4f7a9c1111

steps object[]

Pasos que componen el workflow.

Array [

oneOf

WorkflowStepActionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: ActionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

WorkflowStepConditionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: ConditionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

conditions object[]required

Array [

idstring

Example: 66f01d4f1d0b5a4f7a9c6666

expressionstring

Expresión evaluable sobre metadata del contexto. Soporta operadores ==, !=, >, >=, <, <=, contains, not contains, starts with, ends with, empty, not empty; y rutas anidadas con notación de punto (ej. person.profile.locale).

Example: legal_review_approved == true

step_idstring

Paso destino cuando la condición es verdadera.

Example: 66f01d4f1d0b5a4f7a9c4444

_destroyboolean

Example: false

]

else_step_idstringnullable

Example: 66f01d4f1d0b5a4f7a9c5555

WorkflowStepFilterBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: FilterBlock

next_step_idstringrequired

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

condition objectrequired

idstring

Example: 66f01d4f1d0b5a4f7a9c6666

expressionstring

Expresión evaluable sobre metadata del contexto. Soporta operadores ==, !=, >, >=, <, <=, contains, not contains, starts with, ends with, empty, not empty; y rutas anidadas con notación de punto (ej. person.profile.locale).

Example: legal_review_approved == true

step_idstring

Paso destino cuando la condición es verdadera.

Example: 66f01d4f1d0b5a4f7a9c4444

_destroyboolean

Example: false

WorkflowStepSplitBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: SplitBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

branch_slots object[]

Array [

idstringrequired

Example: 66f01d4f1d0b5a4f7a9c4444

step_idstringnullable

Example: 66f01d4f1d0b5a4f7a9c2222

]

WorkflowStepJoinBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: JoinBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

split_step_idstringnullable

Example: 66f01d4f1d0b5a4f7a9c3333

WorkflowStepSwitchBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: SwitchBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

conditions object[]required

Array [

idstring

Example: 66f01d4f1d0b5a4f7a9c6666

expressionstring

Expresión evaluable sobre metadata del contexto. Soporta operadores ==, !=, >, >=, <, <=, contains, not contains, starts with, ends with, empty, not empty; y rutas anidadas con notación de punto (ej. person.profile.locale).

Example: legal_review_approved == true

step_idstring

Paso destino cuando la condición es verdadera.

Example: 66f01d4f1d0b5a4f7a9c4444

_destroyboolean

Example: false

]

else_step_idstringnullable

Example: 66f01d4f1d0b5a4f7a9c5555

WorkflowStepDelayedActionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: DelayedActionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

delay_minutesintegerrequired

Possible values: >= 1 and <= 524160

Example: 10

delay_variable_pathstringnullable

Example: approval.delay_value

delay_variable_unitstring

Possible values: [minutes, hours, days, weeks]

Example: days

WorkflowStepDsrStateTransitionActionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: DsrStateTransitionActionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

actionstring

Possible values: [resolve]

Example: resolve

terminal_statestring

Possible values: [approved, partially_approved, rejected]

Example: approved

rejection_reason_templatestringnullable

Example: Falta validar {{data_subject_request.contact_information.email}}

email_content_templatestringnullable

Example: Hola {{data_subject_request.contact_information.email}}, tu solicitud fue resuelta.

WorkflowStepEmailActionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: EmailActionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

tostring

Example: legal@company.com

subjectstring

Example: Revisión pendiente

bodystring

Example: Revisa la solicitud pendiente

WorkflowStepFormBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: FormBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

titlestringrequired

Example: Confirm legal review

descriptionstringnullable

Example: Internal reviewer handoff

form_descriptionstringnullable

Example: Collect an internal decision before continuing.

submit_button_labelstring

Example: Send form

recipient_typestringrequired

Possible values: [specific_company_user, dsr_assignee]

Example: specific_company_user

recipient_company_user_tokenstringnullable

Example: cusr_1B2M2Y8AsgTpgAmY7PhCfg

fields object[]required

Array [

keystringrequired

Clave estable para almacenar la respuesta del campo.

Example: decision

labelstringrequired

Etiqueta visible del campo en el formulario.

Example: Decision

typestringrequired

Possible values: [text, textarea, boolean, select]

Example: select

requiredbooleanrequired

Example: true

optionsstring[]

Opciones permitidas cuando type es select.

Example: ["approve","reject"]

]

WorkflowStepHttpRequestActionBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: HttpRequestActionBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

urlstringrequired

Example: https://api.example.com/orders/{{order.id}}

methodstringrequired

Possible values: [GET, POST, PUT, PATCH, DELETE]

Example: POST

headers object[]

Array [

keystringrequired

Nombre del header.

Example: Authorization

valuestringrequired

Valor del header.

Example: Bearer {{token}}

]

bodystring

Example: {"status":"approved"}

timeout_secondsintegerrequired

Possible values: >= 1 and <= 120

Example: 15

expected_response_schema object[]

Array [

pathstringrequired

Ruta del campo en payload, con notación de punto para anidados.

Example: reviewer.id

typestringrequired

Possible values: [string, integer, number, boolean, object, array, any]

Example: string

requiredbooleanrequired

Indica si el campo es obligatorio para disparar el workflow.

Example: true

]

response_extractors object[]

Array [

pathstringrequired

Ruta del campo en el body de respuesta JSON.

Example: result.ticket_id

keystringrequired

Nombre de la variable extraída en metadata.

Example: ticket_id

typestringrequired

Possible values: [string, integer, number, boolean, object, array, any]

Example: string

requiredbooleanrequired

Indica si el valor extraído es obligatorio.

Example: true

]

WorkflowStepProcessDsrTriggerBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: ProcessDsrTriggerBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

settings object

property name*any

WorkflowStepTriggerBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: TriggerBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

settings object

property name*any

WorkflowStepWebhookTriggerBlock

idstringrequired

ID del paso (Mongoid embedded document id).

Example: 66f01d4f1d0b5a4f7a9c1111

typestringrequired

Constant value: WebhookTriggerBlock

next_step_idstringnullable

Siguiente paso para secuencia lineal.

Example: 66f01d4f1d0b5a4f7a9c2222

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

settings object

property name*any

public_webhook_tokenstringrequired

Token público generado para recibir llamadas webhook.

Example: whk_YWJjMTIzZXhhbXBsZV90b2tlbg

expected_payload_schema object[]

Campos del payload esperados para disparar el workflow.

Array [

pathstringrequired

Ruta del campo en payload, con notación de punto para anidados.

Example: reviewer.id

typestringrequired

Possible values: [string, integer, number, boolean, object, array, any]

Example: string

requiredbooleanrequired

Indica si el campo es obligatorio para disparar el workflow.

Example: true

]

]

created_atstring<date-time>

Example: 2024-03-21T10:00:00Z

updated_atstring<date-time>

Example: 2024-03-21T10:05:00Z

Workflow

{
  "id": "wf_1B2M2Y8AsgTpgAmY7PhCfg",
  "name": "Flujo de revisión legal DSR",
  "description": "Orquesta revisión legal y transición de estado",
  "status": "draft",
  "runs_count": 42,
  "created_by": {
    "id": "cusr_1B2M2Y8AsgTpgAmY7PhCfg",
    "name": "Catalina Sepúlveda",
    "email": "catalina@company.com"
  },
  "settings": {
    "failure_alerts": {
      "enabled": false
    }
  },
  "starting_step_id": "66f01d4f1d0b5a4f7a9c1111",
  "steps": [
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "conditions": [
        {
          "id": "66f01d4f1d0b5a4f7a9c6666",
          "expression": "legal_review_approved == true",
          "step_id": "66f01d4f1d0b5a4f7a9c4444",
          "_destroy": false
        }
      ],
      "else_step_id": "66f01d4f1d0b5a4f7a9c5555"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "condition": {
        "id": "66f01d4f1d0b5a4f7a9c6666",
        "expression": "legal_review_approved == true",
        "step_id": "66f01d4f1d0b5a4f7a9c4444",
        "_destroy": false
      }
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "branch_slots": [
        {
          "id": "66f01d4f1d0b5a4f7a9c4444",
          "step_id": "66f01d4f1d0b5a4f7a9c2222"
        }
      ]
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "split_step_id": "66f01d4f1d0b5a4f7a9c3333"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "conditions": [
        {
          "id": "66f01d4f1d0b5a4f7a9c6666",
          "expression": "legal_review_approved == true",
          "step_id": "66f01d4f1d0b5a4f7a9c4444",
          "_destroy": false
        }
      ],
      "else_step_id": "66f01d4f1d0b5a4f7a9c5555"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "delay_minutes": 10,
      "delay_variable_path": "approval.delay_value",
      "delay_variable_unit": "days"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "action": "resolve",
      "terminal_state": "approved",
      "rejection_reason_template": "Falta validar {{data_subject_request.contact_information.email}}",
      "email_content_template": "Hola {{data_subject_request.contact_information.email}}, tu solicitud fue resuelta."
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "to": "legal@company.com",
      "subject": "Revisión pendiente",
      "body": "Revisa la solicitud pendiente"
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "title": "Confirm legal review",
      "description": "Internal reviewer handoff",
      "form_description": "Collect an internal decision before continuing.",
      "submit_button_label": "Send form",
      "recipient_type": "specific_company_user",
      "recipient_company_user_token": "cusr_1B2M2Y8AsgTpgAmY7PhCfg",
      "fields": [
        {
          "key": "decision",
          "label": "Decision",
          "type": "select",
          "required": true,
          "options": [
            "approve",
            "reject"
          ]
        }
      ]
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "url": "https://api.example.com/orders/{{order.id}}",
      "method": "POST",
      "headers": [
        {
          "key": "Authorization",
          "value": "Bearer {{token}}"
        }
      ],
      "body": "{\"status\":\"approved\"}",
      "timeout_seconds": 15,
      "expected_response_schema": [
        {
          "path": "reviewer.id",
          "type": "string",
          "required": true
        }
      ],
      "response_extractors": [
        {
          "path": "result.ticket_id",
          "key": "ticket_id",
          "type": "string",
          "required": true
        }
      ]
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "settings": {}
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "settings": {}
    },
    {
      "id": "66f01d4f1d0b5a4f7a9c1111",
      "type": "string",
      "next_step_id": "66f01d4f1d0b5a4f7a9c2222",
      "created_at": "2024-03-21T10:00:00Z",
      "updated_at": "2024-03-21T10:05:00Z",
      "settings": {},
      "public_webhook_token": "whk_YWJjMTIzZXhhbXBsZV90b2tlbg",
      "expected_payload_schema": [
        {
          "path": "legal_review_approved",
          "type": "boolean",
          "required": true
        },
        {
          "path": "reviewer.id",
          "type": "string",
          "required": true
        }
      ]
    }
  ],
  "created_at": "2024-03-21T10:00:00Z",
  "updated_at": "2024-03-21T10:05:00Z"
}