Workday Extend Orchestration Triggers API

openapi: 3.2.0
info:
  title: Workday Extend Workday Orchestration Orchestration Triggers…
  description: APIs for creating and managing orchestrations that automate business processes and integrate with external systems. Developers visually build orchestrations using the Orchestration Builder to define flows, map data, and perform transformations. Orchestrations can be triggered from Extend apps, business processes, integration systems, or external systems via API triggers.
  version: v1
  contact:
    name: Workday Developer Support
    url: https://support.developer.workday.com/s/
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{baseUrl}/api/orchestrate/v1/{tenant}
  description: Workday Orchestrate API Server
  variables:
    baseUrl:
      default: api.workday.com
    tenant:
      default: tenant
security:
- OAuth2:
  - orchestrate:orchestrations
tags:
- name: Orchestration Triggers
  description: Operations for configuring orchestration triggers including event-based, scheduled, and API-triggered orchestrations.
paths:
  /orchestrations/{orchestrationId}/triggers:
    get:
      operationId: listOrchestrationTriggers
      summary: Workday Extend List orchestration triggers
      description: Returns the collection of triggers configured for the specified orchestration, including event-based, scheduled, and API triggers.
      tags:
      - Orchestration Triggers
      parameters:
      - $ref: '#/components/parameters/orchestrationId'
      responses:
        '200':
          description: Successful response with orchestration triggers
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrchestrationTrigger'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createOrchestrationTrigger
      summary: Workday Extend Create an orchestration trigger
      description: Adds a new trigger to the specified orchestration. Triggers define how and when the orchestration is executed, including event-based triggers from business processes and scheduled triggers.
      tags:
      - Orchestration Triggers
      parameters:
      - $ref: '#/components/parameters/orchestrationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrchestrationTriggerCreate'
      responses:
        '201':
          description: Trigger successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrchestrationTrigger'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    OrchestrationTrigger:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the trigger
        type:
          type: string
          enum:
          - event
          - api
          - schedule
          - business_process
          description: The type of trigger
        name:
          type: string
          description: Name of the trigger
        description:
          type: string
          description: Description of the trigger
        isActive:
          type: boolean
          description: Whether the trigger is currently active
        configuration:
          type: object
          additionalProperties: true
          description: Trigger-specific configuration
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
    OrchestrationTriggerCreate:
      type: object
      required:
      - type
      - name
      properties:
        type:
          type: string
          enum:
          - event
          - api
          - schedule
          - business_process
          description: The type of trigger
        name:
          type: string
          description: Name for the trigger
        description:
          type: string
          description: Description of the trigger
        configuration:
          type: object
          additionalProperties: true
          description: Trigger-specific configuration parameters
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    orchestrationId:
      name: orchestrationId
      in: path
      required: true
      description: The unique identifier of the orchestration
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            orchestrate:orchestrations: Manage orchestrations
            orchestrate:orchestrations:read: Read orchestration data
            orchestrate:executions: Execute orchestrations
externalDocs:
  description: Workday Orchestrations Documentation
  url: https://doc.workday.com/extend/orchestrations/