Workday Business Processes

Workday Custom Business Process Config API

Create, read, update and delete custom business process types and their event task definitions.

Documentation GitHub OpenAPI

Operations 11

POST /types #

GET /types #

GET /types/{id} #

PUT /types/{id} #

DELETE /types/{id} #

POST /eventTaskDefinitions #

GET /eventTaskDefinitions #

GET /eventTaskDefinitions/{id} #

PUT /eventTaskDefinitions/{id} #

PATCH /eventTaskDefinitions/{id} #

DELETE /eventTaskDefinitions/{id} #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/workday-business-processes-custom-business-process-config-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.0.1
info:
  description: The public APIs to create and manage custom business process configurations.
  version: v1
  title: Custom Business Process Config
  x-api-evangelist-harvested: '2026-09-17'
  x-api-evangelist-source: https://developer.workday.com/bundles/rest-directory-ui/public/static/openApiFiles/customBusinessProcessConfig_v1_swagger.json
tags:
- name: Types
  description: A collection of custom business process types defined in Workday.
- name: Event Task Definitions
  description: A collection of Event Task Definitions for custom business process defined in Workday.
paths:
  /types:
    post:
      tags:
      - Types
      description: Creates a new custom business process type, including initiating actions.
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCustomBusinessProcessTypeDetail'
      responses:
        '200':
          description: Creates a new custom business process type instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessTypeDetail'
        '400':
          description: 'Possible Validations:


            - The name for custom business process type is required and must be unique across all custom business process
            types.


            - The name for initiating actions is required and must be unique within a custom business process type.


            - The referenceIdValue must be unique across all custom business process types.


            - The referenceIdValue for initiatingActions must be unique across all initiating actions.


            - Custom object is not valid for target business object.


            - You are not allowed to set more than one initiating allowed action as default.


            - The Custom Task cannot be used by more than one initiating allowed action.


            - The Event Task Definition is required for the Event Action Task Configuration


            - The Event Action is required for the Event Action Task Configuration

            '
      security:
      - oAuth2:
        - write
        - read
    get:
      tags:
      - Types
      description: Returns summary of all custom business process types
      operationId: get
      responses:
        '200':
          description: Returns summary of all custom business process types
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allCustomBusinessProcessTypeDetails'
      security:
      - oAuth2:
        - write
        - read
  /types/{id}:
    get:
      tags:
      - Types
      description: Returns a custom business process type
      operationId: view
      parameters:
      - name: id
        in: path
        description: The Workday Id of the custom business process type
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a custom business process type for the Id supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessTypeDetail'
        '404':
          description: Not Found.
      security:
      - oAuth2:
        - write
        - read
    put:
      tags:
      - Types
      description: Updates a custom business process type
      operationId: update
      parameters:
      - name: id
        in: path
        description: The Workday Id of the custom business process type
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/editCustomBusinessProcessTypeDetail'
        description: Custom business process type data to be updated.
        required: true
      responses:
        '200':
          description: Updates a custom business process type for the Id supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessTypeDetail'
        '400':
          description: 'Possible Validations:


            -The referenceIdValue must be unique across all custom business process types.


            -The name for custom business process type must be unique across all custom business process types.


            -Custom object is not valid for target business object.


            -Changes to the custom object are not allowed once an event exists for this custom business process.


            -Changes to the business object are not allowed once an event exists for this custom business process.


            -Changes to the Name are not allowed once an event exists for this custom business process.


            -Changes to the ID are not allowed once an event exists for this custom business process.

            '
      security:
      - oAuth2:
        - write
        - read
    delete:
      tags:
      - Types
      description: Deletes a custom business process type
      operationId: delete
      parameters:
      - name: id
        in: path
        description: The Workday Id of the custom business process type
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deletes a custom business process type for the Id supplied
        '400':
          description: 'Possible Validations:

            - The custom business process type cannot be deleted because it has references.

            - You cannot delete a custom business process type that has been used by a business process event.'
        '404':
          description: Not Found.
      security:
      - oAuth2:
        - write
        - read
  /eventTaskDefinitions:
    post:
      tags:
      - Event Task Definitions
      description: Creates a new event task definition.
      operationId: createEventTaskDefinition
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCustomBusinessProcessEventTaskDetail'
      responses:
        '200':
          description: Creates a new custom event task definition instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessEventTaskDetail'
        '400':
          description: 'Poossible Validations:


            -The name for event task definition is required and must be unique across all event task definitions.


            -VPS application is a required field.


            -VPS site is a required field.


            -The referenceIdValue must be unique across all VPS definitions.

            '
      security:
      - oAuth2:
        - write
        - read
    get:
      tags:
      - Event Task Definitions
      description: Returns summary of all event task definitions
      operationId: getEventTaskDefinition
      responses:
        '200':
          description: Returns summary of all event task definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allCustomBusinessProcessEventTaskDetails'
      security:
      - oAuth2:
        - write
        - read
  /eventTaskDefinitions/{id}:
    get:
      tags:
      - Event Task Definitions
      description: Returns a event task definition
      operationId: viewEventTaskDefinition
      parameters:
      - name: id
        in: path
        description: The Workday Id of the event task definition
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a event task definition for the Id supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessEventTaskDetail'
        '404':
          description: Not Found.
      security:
      - oAuth2:
        - write
        - read
    put:
      tags:
      - Event Task Definitions
      description: Updates a event task definition.
      operationId: updateEventTaskDefinition
      parameters:
      - name: id
        in: path
        description: The Workday Id of the event task definition
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/editCustomBusinessProcessEventTaskDetail'
        description: Event task definition data to be updated.
        required: true
      responses:
        '200':
          description: Updates a event task definition for the Id supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessEventTaskDetail'
        '400':
          description: 'Possible Validations:


            -The name for event task definition is required and must be unique across all event task definitions.


            -VPS application is a required field.


            -VPS site is a required field.


            -The referenceIdValue must be unique across all event task definitions.

            '
      security:
      - oAuth2:
        - write
        - read
    patch:
      tags:
      - Event Task Definitions
      description: Updates a event task definition.
      operationId: patchEventTaskDefinition
      parameters:
      - name: id
        in: path
        description: The Workday Id of the event task definition
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchCustomBusinessProcessEventTaskDetail'
        description: Event task definition data to be updated.
        required: true
      responses:
        '200':
          description: Updates a event task definition for the Id supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customBusinessProcessEventTaskDetail'
        '400':
          description: 'Possible Validations:


            -The name for event task definition is required and must be unique across all event task definitions.


            -VPS application is a required field.


            -VPS site is a required field.


            -The referenceIdValue must be unique across all event task definitions.

            '
      security:
      - oAuth2:
        - write
        - read
    delete:
      tags:
      - Event Task Definitions
      description: Deletes a event task definition
      operationId: deleteEventTaskDefinition
      parameters:
      - name: id
        in: path
        description: The Workday Id of the event task definition
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deletes a event task definition for the Id supplied
        '400':
          description: The event task definition cannot be deleted because it has references.
        '404':
          description: Not Found.
      security:
      - oAuth2:
        - write
        - read
servers:
- url: https://api.workday.com/customBusinessProcessConfig/v1
components:
  securitySchemes:
    oAuth2:
      type: oauth2
      description: Register an API Client
      flows:
        implicit:
          authorizationUrl: https://auth.api.workday.com/v1/authorize
          scopes:
            write: modify custom business process types
            read: read custom business process types
  schemas:
    allCustomBusinessProcessTypeDetails:
      type: object
      properties:
        total:
          type: number
        data:
          type: array
          items:
            $ref: '#/components/schemas/customBusinessProcessTypeDetail'
    customBusinessProcessTypeDetail:
      type: object
      required:
      - name
      properties:
        id:
          type: string
        Custom_Business_Process_Type_ID:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        referenceIdValue:
          type: string
        eventActions:
          type: array
          items:
            $ref: '#/components/schemas/eventActionWithID'
        eventActionTaskConfig:
          type: array
          items:
            $ref: '#/components/schemas/eventActionEventTaskConfigResponse'
        initiatingActions:
          type: array
          items:
            $ref: '#/components/schemas/initiatingActionDetailResponse'
        stepActions:
          type: array
          items:
            $ref: '#/components/schemas/stepActionDetailResponse'
        customObjectDefinition:
          $ref: '#/components/schemas/instanceWithIdAndDescriptor'
        targetBusinessObject:
          $ref: '#/components/schemas/instanceWithIdAndDescriptor'
    createCustomBusinessProcessTypeDetail:
      type: object
      required:
      - name
      properties:
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        eventActions:
          type: array
          items:
            $ref: '#/components/schemas/instanceWithId'
        eventActionTaskConfig:
          type: array
          items:
            $ref: '#/components/schemas/eventActionEventTaskConfigRequest'
        initiatingActions:
          type: array
          items:
            $ref: '#/components/schemas/initiatingActionDetailRequest'
        stepActions:
          type: array
          items:
            $ref: '#/components/schemas/stepActionDetailRequest'
        customObjectDefinition:
          $ref: '#/components/schemas/instanceWithId'
        targetBusinessObject:
          $ref: '#/components/schemas/instanceWithId'
    eventActionEventTaskConfigResponse:
      type: object
      properties:
        id:
          type: string
        eventAction:
          $ref: '#/components/schemas/eventActionWithID'
        eventTaskDefinition:
          $ref: '#/components/schemas/instanceWithIdAndDescriptor'
    eventActionEventTaskConfigRequest:
      type: object
      required:
      - eventAction
      - eventTaskDefinition
      properties:
        eventAction:
          $ref: '#/components/schemas/instanceWithId'
        eventTaskDefinition:
          $ref: '#/components/schemas/instanceWithId'
    eventActionWithID:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        Event_Action_Type_ID:
          type: string
    editCustomBusinessProcessTypeDetail:
      type: object
      required:
      - name
      properties:
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        customObjectDefinition:
          $ref: '#/components/schemas/instanceWithId'
        targetBusinessObject:
          $ref: '#/components/schemas/instanceWithId'
    initiatingActionDetailResponse:
      type: object
      properties:
        id:
          type: string
        Initiating_Action_ID:
          type: string
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        default:
          type: boolean
        customTask:
          $ref: '#/components/schemas/instanceWithIdAndDescriptor'
    initiatingActionDetailRequest:
      type: object
      required:
      - name
      properties:
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        default:
          type: boolean
        customTask:
          $ref: '#/components/schemas/instanceWithId'
    stepActionDetailResponse:
      type: object
      properties:
        id:
          type: string
        Step_Action_ID:
          type: string
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        eventTaskDefinition:
          $ref: '#/components/schemas/instanceWithIdAndDescriptor'
    stepActionDetailRequest:
      type: object
      required:
      - name
      properties:
        referenceIdValue:
          type: string
        name:
          type: string
        description:
          type: string
        inactive:
          type: boolean
        eventTaskDefinition:
          $ref: '#/components/schemas/instanceWithId'
    instanceWithId:
      type: object
      properties:
        id:
          type: string
    instanceWithIdAndDescriptor:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
    createCustomBusinessProcessEventTaskDetail:
      type: object
      required:
      - vpsApplication
      - name
      - vpsSite
      properties:
        name:
          type: string
        description:
          type: string
        vpsApplication:
          type: string
        vpsSite:
          type: string
        vpsRoute:
          type: string
        referenceIdValue:
          type: string
    editCustomBusinessProcessEventTaskDetail:
      type: object
      required:
      - vpsApplication
      - name
      - vpsSite
      properties:
        name:
          type: string
        description:
          type: string
        vpsApplication:
          type: string
        vpsSite:
          type: string
        vpsRoute:
          type: string
        referenceIdValue:
          type: string
    patchCustomBusinessProcessEventTaskDetail:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        vpsApplication:
          type: string
        vpsSite:
          type: string
        vpsRoute:
          type: string
        referenceIdValue:
          type: string
    customBusinessProcessEventTaskDetail:
      type: object
      required:
      - vpsApplication
      - name
      - vpsSite
      properties:
        id:
          type: string
        Event_Task_Definition_ID:
          type: string
        name:
          type: string
        description:
          type: string
        referenceIdValue:
          type: string
        vpsApplication:
          type: string
        vpsSite:
          type: string
        vpsRoute:
          type: string
    allCustomBusinessProcessEventTaskDetails:
      type: object
      properties:
        total:
          type: number
        data:
          type: array
          items:
            $ref: '#/components/schemas/customBusinessProcessEventTaskDetail'