Scout RFP Events API

openapi: 3.0.3
info:
  title: Workday Strategic Sourcing Bids Events API
  description: The Events API (formerly Scout RFP Events API) enables management of sourcing events including RFPs, RFIs, and reverse auctions within the Workday Strategic Sourcing platform. Supports creating events from templates, managing suppliers, worksheets, line items, and collecting bids.
  version: '1.3'
  contact:
    url: https://apidocs.workdayspend.com/
servers:
- url: https://api.us.workdayspend.com/services/events/v1
  description: US Production
- url: https://api.sandbox.us.workdayspend.com/services/events/v1
  description: US Sandbox
- url: https://api.eu.workdayspend.com/services/events/v1
  description: EU Production
- url: https://api.ca.workdayspend.com/services/events/v1
  description: CA Production
security:
- ApiKeyAuth: []
  UserTokenAuth: []
  UserEmailAuth: []
tags:
- name: Events
paths:
  /events:
    get:
      operationId: listEvents
      summary: List Events
      description: Retrieve a paginated list of sourcing events with optional filtering.
      tags:
      - Events
      parameters:
      - name: page[size]
        in: query
        description: Number of results per page (default 10, max 100)
        required: false
        schema:
          type: integer
          default: 10
          maximum: 100
      - name: filter
        in: query
        description: Filter criteria for events (max 5 filters recommended)
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: Related resources to include in the response
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response with list of events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsListResponse'
        '401':
          description: Unauthorized - invalid or missing authentication
        '429':
          description: Rate limit exceeded (max 5 requests per second)
    post:
      operationId: createEvent
      summary: Create Event
      description: Create a new sourcing event from an existing template.
      tags:
      - Events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventCreateRequest'
      responses:
        '201':
          description: Event created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
        '400':
          description: Bad request - invalid parameters
        '401':
          description: Unauthorized
  /events/describe:
    get:
      operationId: describeEvent
      summary: Describe Event Fields
      description: Get field definitions for the event object.
      tags:
      - Events
      responses:
        '200':
          description: Event field definitions
          content:
            application/json:
              schema:
                type: object
  /events/{id}:
    get:
      operationId: getEvent
      summary: Get Event
      description: Retrieve details of a specific sourcing event by ID.
      tags:
      - Events
      parameters:
      - name: id
        in: path
        required: true
        description: Event identifier
        schema:
          type: string
      responses:
        '200':
          description: Event details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
        '404':
          description: Event not found
    patch:
      operationId: updateEvent
      summary: Update Event
      description: Update properties of an existing sourcing event.
      tags:
      - Events
      parameters:
      - name: id
        in: path
        required: true
        description: Event identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventUpdateRequest'
      responses:
        '200':
          description: Event updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
    delete:
      operationId: deleteEvent
      summary: Delete Event
      description: Delete a sourcing event.
      tags:
      - Events
      parameters:
      - name: id
        in: path
        required: true
        description: Event identifier
        schema:
          type: string
      responses:
        '204':
          description: Event deleted successfully
components:
  schemas:
    EventUpdateRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            attributes:
              type: object
    EventCreateRequest:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              example: events
            attributes:
              type: object
              properties:
                title:
                  type: string
                event_type:
                  type: string
                external_id:
                  type: string
                custom_fields:
                  type: array
                  items:
                    type: object
            relationships:
              type: object
              properties:
                event_template:
                  type: object
    EventResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Event'
    Event:
      type: object
      properties:
        id:
          type: string
          description: Unique event identifier
        type:
          type: string
          example: events
        attributes:
          type: object
          properties:
            title:
              type: string
              description: Event title
            spend_amount:
              type: number
              description: Expected spend amount
            event_type:
              type: string
              description: Type of event (RFP, RFI, auction, etc.)
            state:
              type: string
              description: Current state of the event
            external_id:
              type: string
              description: External system identifier
            supplier_rsvp_deadline:
              type: string
              format: date-time
              description: Deadline for supplier RSVPs
            supplier_question_deadline:
              type: string
              format: date-time
              description: Deadline for supplier questions
            bid_submission_deadline:
              type: string
              format: date-time
              description: Deadline for bid submissions
            late_bids:
              type: boolean
              description: Whether late bids are accepted
            revise_bids:
              type: boolean
              description: Whether bid revisions are allowed
            instant_notifications:
              type: boolean
              description: Enable instant notifications
            is_public:
              type: boolean
              description: Whether the event is public
            restricted:
              type: boolean
              description: Whether event access is restricted
            custom_fields:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
    EventsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        meta:
          type: object
          properties:
            total_count:
              type: integer
        links:
          type: object
          properties:
            self:
              type: string
            next:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Company-wide API key
    UserTokenAuth:
      type: apiKey
      in: header
      name: X-User-Token
      description: User-specific API token
    UserEmailAuth:
      type: apiKey
      in: header
      name: X-User-Email
      description: User email address