Baserow Builder workflow actions API

openapi: 3.0.3
info:
  title: Baserow API spec Admin Builder workflow actions API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
tags:
- name: Builder workflow actions
paths:
  /api/builder/domains/published/page/{page_id}/workflow_actions/:
    get:
      operationId: list_public_builder_page_workflow_actions
      description: Lists all the workflow actions with their public accessible data. Some configuration might be omitted for security reasons such as passwords or PII.
      parameters:
      - in: path
        name: page_id
        schema:
          type: integer
        description: Returns only the public workflow actions of the page related to the provided Id.
        required: true
      tags:
      - Builder workflow actions
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/public_Builder_Workflow_Action_TypeBuilderWorkflowAction'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_PAGE_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/builder/page/{page_id}/workflow_actions/:
    get:
      operationId: list_builder_page_workflow_actions
      description: Lists all the workflow actions of the page related to the provided parameter if the user has access to the related builder's workspace. If the workspace is related to a template, then this endpoint will be publicly accessible.
      parameters:
      - in: path
        name: page_id
        schema:
          type: integer
        description: Returns only the workflow actions of the page related to the provided Id.
        required: true
      tags:
      - Builder workflow actions
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_PAGE_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    post:
      operationId: create_builder_page_workflow_action
      description: Creates a new builder workflow action
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: path
        name: page_id
        schema:
          type: integer
        description: Creates a workflow action for the builder page related to the provided value.
        required: true
      tags:
      - Builder workflow actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction'
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_PAGE_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/builder/page/{page_id}/workflow_actions/order/:
    post:
      operationId: order_builder_workflow_actions
      description: Apply a new order to the workflow actions of a page
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: path
        name: page_id
        schema:
          type: integer
        description: The page the workflow actions belong to
        required: true
      tags:
      - Builder workflow actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderWorkflowActions'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrderWorkflowActions'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrderWorkflowActions'
        required: true
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_PAGE_DOES_NOT_EXIST
                    - ERROR_WORKFLOW_ACTION_DOES_NOT_EXIST
                    - ERROR_WORKFLOW_ACTION_NOT_IN_ELEMENT
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/builder/workflow_action/{workflow_action_id}/:
    patch:
      operationId: update_builder_page_workflow_action
      description: Updates an existing builder workflow action.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: path
        name: workflow_action_id
        schema:
          type: integer
        description: The id of the workflow action
        required: true
      tags:
      - Builder workflow actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions'
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_WORKFLOW_ACTION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    delete:
      operationId: delete_builder_page_workflow_action
      description: Deletes the workflow action related by the given id.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: path
        name: workflow_action_id
        schema:
          type: integer
        description: The id of the workflow action
        required: true
      tags:
      - Builder workflow actions
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_WORKFLOW_ACTION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/builder/workflow_action/{workflow_action_id}/dispatch/:
    post:
      operationId: dispatch_builder_page_workflow_action
      description: Dispatches the service of the related workflow_action and returns the result.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: path
        name: workflow_action_id
        schema:
          type: integer
        description: The id of the workflow_action you want to call the dispatch for.
        required: true
      tags:
      - Builder workflow actions
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_WORKFLOW_ACTION_CANNOT_BE_DISPATCHED
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  schemas:
    LocalBaserowUpdateRowWorkflowActionBuilderWorkflowAction:
      type: object
      description: Basic builder workflow action serializer
      properties:
        id:
          type: integer
          readOnly: true
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        element_id:
          type: integer
          nullable: true
          readOnly: true
        type:
          type: string
          readOnly: true
          description: The type of the workflow action
        event:
          type: string
          description: The event that triggers the execution
          maxLength: 60
        service:
          allOf:
          - $ref: '#/components/schemas/Integration_ServiceService'
          description: The service which this workflow action is associated with.
      required:
      - element_id
      - event
      - id
      - order
      - service
      - type
    CorePeriodicServiceBasePolymorphicRequest:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        interval:
          allOf:
          - $ref: '#/components/schemas/Interval3bdEnum'
          description: 'The interval frequency for running the service.


            * `MINUTE` - MINUTE

            * `HOUR` - HOUR

            * `DAY` - DAY

            * `WEEK` - WEEK

            * `MONTH` - MONTH'
        minute:
          type: integer
          maximum: 59
          minimum: 0
          nullable: true
          description: The minute of the hour when to run (0-59). Required for hourly, daily, weekly, monthly intervals.
        hour:
          type: integer
          maximum: 23
          minimum: 0
          nullable: true
          description: The hour of the day when to run (0-23). Required for daily, weekly, monthly intervals.
        day_of_week:
          type: integer
          maximum: 6
          minimum: 0
          nullable: true
          description: The day of the week when to run (0=Monday, 6=Sunday). Required for weekly intervals.
        day_of_month:
          type: integer
          maximum: 31
          minimum: 1
          nullable: true
          description: The day of the month when to run (1-31). Required for monthly intervals.
        next_run_at:
          type: string
          format: date-time
          nullable: true
          description: The next scheduled time for this service to run. Automatically calculated based on the interval and schedule fields.
      required:
      - id
      - interval
    ButtonTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    ButtonWidthEnum:
      enum:
      - auto
      - full
      type: string
      description: '* `auto` - Auto

        * `full` - Full'
    CoreIteratorServiceBasePolymorphicRequest:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        source:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: The path of the array.
      required:
      - id
    Heading6FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    LocalBaserowRowsDeletedBasePolymorphicRequest:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        table_id:
          type: integer
          nullable: true
          description: The id of the Baserow table we want the data for.
        integration_id:
          type: integer
          nullable: true
          description: The id of the Baserow integration we want the data for.
      required:
      - id
    CoreSMTPEmailWorkflowActionUpdateBuilderWorkflowActions:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/Type292Enum'
          description: 'The type of the workflow action


            * `notification` - notification

            * `open_page` - open_page

            * `create_row` - create_row

            * `update_row` - update_row

            * `delete_row` - delete_row

            * `logout` - logout

            * `refresh_data_source` - refresh_data_source

            * `http_request` - http_request

            * `smtp_email` - smtp_email

            * `ai_agent` - ai_agent

            * `slack_write_message` - slack_write_message'
        service:
          allOf:
          - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest'
          description: The service which this workflow action is associated with.
    HTTPFormData:
      type: object
      description: Serializer for the Form data model.
      properties:
        id:
          type: integer
          readOnly: true
        key:
          type: string
          maxLength: 255
        value:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
      required:
      - id
      - key
    LocalBaserowGetRowBasePolymorphicRequest:
      type: object
      description: 'A serializer mixin for services which implement the local Baserow filterable mixin.

        It ensures that when serialize the service, *all* filters (including those pointing

        to trashed fields) are serialized.'
      properties:
        id:
          type: integer
          readOnly: true
        table_id:
          type: integer
          nullable: true
          description: The id of the Baserow table we want the data for.
        integration_id:
          type: integer
          nullable: true
          description: The id of the Baserow integration we want the data for.
        view_id:
          type: integer
          nullable: true
          description: The id of the Baserow view we want the data for.
        filter_type:
          allOf:
          - $ref: '#/components/schemas/ConditionTypeEnum'
          description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR).


            * `AND` - And

            * `OR` - Or'
        search_query:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: Any search queries to apply to the service when it is dispatched.
        row_id:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: A formula for defining the intended row.
      required:
      - id
    CustomCode:
      type: object
      properties:
        css:
          type: string
          description: Custom CSS code.
        js:
          type: string
          description: Custom JavaScript code.
    SlackWriteMessageWorkflowActionBuilderWorkflowAction:
      type: object
      description: Basic builder workflow action serializer
      properties:
        id:
          type: integer
          readOnly: true
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        element_id:
          type: integer
          nullable: true
          readOnly: true
        type:
          type: string
          readOnly: true
          description: The type of the workflow action
        event:
          type: string
          description: The event that triggers the execution
          maxLength: 60
        service:
          allOf:
          - $ref: '#/components/schemas/Integration_ServiceService'
          description: The service which this workflow action is associated with.
      required:
      - element_id
      - event
      - id
      - order
      - service
      - type
    LocalBaserowRowsDeletedService:
      type: object
      description: Basic service serializer mostly for returned values.
      properties:
        id:
          type: integer
          readOnly: true
        integration_id:
          type: integer
          nullable: true
          description: The id of the Baserow integration we want the data for.
        type:
          type: string
          readOnly: true
          description: The type of the service.
        schema:
          type: object
          additionalProperties: {}
          readOnly: true
          description: The schema of the service.
        context_data:
          type: object
          additionalProperties: {}
          readOnly: true
          description: The context data of the service.
        context_data_schema:
          type: object
          additionalProperties: {}
          readOnly: true
          description: The schema context data of the service.
        sample_data:
          readOnly: true
          nullable: true
          description: Store the sample data used for generating a schema.
        table_id:
          type: integer
          nullable: true
          description: The id of the Baserow table we want the data for.
      required:
      - context_data
      - context_data_schema
      - id
      - sample_data
      - schema
      - type
    CoreSMTPEmailWorkflowActionBuilderWorkflowAction:
      type: object
      description: Basic builder workflow action serializer
      properties:
        id:
          type: integer
          readOnly: true
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        element_id:
          type: integer
          nullable: true
          readOnly: true
        type:
          type: string
          readOnly: true
          description: The type of the workflow action
        event:
          type: string
          description: The event that triggers the execution
          maxLength: 60
        service:
          allOf:
          - $ref: '#/components/schemas/Integration_ServiceService'
          description: The service which this workflow action is associated with.
      required:
      - element_id
      - event
      - id
      - order
      - service
      - type
    OpenPageWorkflowActionUpdateBuilderWorkflowActions:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/Type292Enum'
          description: 'The type of the workflow action


            * `notification` - notification

            * `open_page` - open_page

            * `create_row` - create_row

            * `update_row` - update_row

            * `delete_row` - delete_row

            * `logout` - logout

            * `refresh_data_source` - refresh_data_source

            * `http_request` - http_request

            * `smtp_email` - smtp_email

            * `ai_agent` - ai_agent

            * `slack_write_message` - slack_write_message'
        navigation_type:
          allOf:
          - $ref: '#/components/schemas/NavigationTypeEnum'
          default: page
          description: 'The navigation type.


            * `page` - Page

            * `custom` - Custom'
        navigate_to_page_id:
          type: integer
          nullable: true
          description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',)
        navigate_to_url:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: If no page is selected, this indicate the destination of the link.
        page_parameters:
          type: array
          items:
            $ref: '#/components/schemas/PageParameterValue'
          default: []
          description: The parameters for each parameters of the selected page if any.
        query_parameters:
          type: array
          items:
            $ref: '#/components/schemas/PageParameterValue'
          default: []
          description: The query parameters for each parameter of the selected page if any.
        target:
          allOf:
          - $ref: '#/components/schemas/TargetEnum'
          default: self
          description: 'The target of the link when we click on it.


            * `self` - Self

            * `blank` - Blank'
    Heading5TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    NotificationWorkflowActionUpdateBuilderWorkflowActions:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/Type292Enum'
          description: 'The type of the workflow action


            * `notification` - notification

            * `open_page` - open_page

            * `create_row` - create_row

            * `update_row` - update_row

            * `delete_row` - delete_row

            * `logout` - logout

            * `refresh_data_source` - refresh_data_source

            * `http_request` - http_request

            * `smtp_email` - smtp_email

            * `ai_agent` - ai_agent

            * `slack_write_message` - slack_write_message'
        title:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: The title of the notification. Must be an formula.
        description:
          type: object
          additionalProperties: {}
          default:
            formula: ''
            version: '0.1'
            mode: simple
          description: The description of the notification. Must be an formula.
    OrderWorkflowActions:
      type: object
      properties:
        workflow_action_ids:
          type: array
          items:
            type: integer
          description: The ids of the workflow actions in the order they are supposed to be set in
        element_id:
          type: integer
          description: The element the workflow actions belong to
      required:
      - workflow_action_ids
    App_Auth_ProviderAppAuthProvider:
      oneOf:
      - $ref: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider'
      - $ref: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider'
      - $ref: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider'
      discriminator:
        propertyName: type
        mapping:
          local_baserow_password: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider'
          saml: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider'
          openid_connect: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider'
    Heading6TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    SlackWriteMessageWorkflowActionUpdateBuilderWorkflowActions:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/Type292Enum'
          descr

# --- truncated at 32 KB (162 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/openapi/baserow-builder-workflow-actions-api-openapi.yml