Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CXoneWorkflowRequest

Interface used as a intermediate for creating request json for API call

@example
Array<CXoneCRMWorkflowRequest>

Hierarchy

  • CXoneWorkflowRequest

Index

Properties

Properties

action

action: string
remarks
  • type of Action

Optional cacheKey

cacheKey?: string
remarks
  • cache key

Optional configurationId

configurationId?: string
remarks

-Agent Integration configuration id

Optional contactID

contactID?: string

contactID

Optional customSearch

customSearch?: any
remarks
  • custom Search Payload

Optional cxoneContact

cxoneContact?: CXoneDigitalContactData | CXoneVoiceContactData

cxone contact information of different CRM flows

Optional dataMappingId

dataMappingId?: string
remarks
  • Data Mapping Id

Optional dynamicDataMappingId

dynamicDataMappingId?: string
remarks
  • Dynamic Data Mapping Id

Optional entity

entity?: string
remarks
  • relatable entity system name

Optional entityId

entityId?: string
remarks
  • relatable entity id

Optional integration

integration?: RelatesToEntity[]
remarks
  • Data Memorialization Workflow Payload - changed to RelatesTo because of extending from CXoneIntegrationEntity

Optional interactionID

interactionID?: string

interactionID

Optional relatedObject

relatedObject?: { entityType?: string; name: string; value: string }
remarks
  • related entity object payload

Type declaration

  • Optional entityType?: string
    remarks
    • related entity type
  • name: string
    remarks
    • related entity name
  • value: string
    remarks
    • related entity value

Optional workflowId

workflowId?: string
remarks

-Agent Integration workflow id

Optional workflowInput

workflowInput?: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string }

paramter for workflow search

Type declaration

  • Optional action?: string

    string of action we want to take for Trigger worklows

  • Optional email?: string
    remarks
    • Email id
  • Optional entites?: CXoneIntegrationEntity[]

    Array of CRM Entities to search comma separated string

  • Optional id?: string

    String of ID for popping EPIC Health record

  • Optional phoneNumber?: string
    remarks
    • Phone Number
  • Optional recipientId?: string

    agent id will fill this value for the epic screen pop

  • Optional type?: string

    string of entity type for screen pop workflow

Generated using TypeDoc