ROroarkhq
Customer Flow

Create a customer flow

Changed on

Creates a customer flow. A SCRIPTED flow carries a step graph and gets one way of running it per path through the graph; an IMPROV flow carries the briefs you send. Customer flows replace the older simulation scenarios, so build a flow for anything new.

post/v1/customer-flow

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/customer-flow
  • Auth
    HTTP bearer

Request body

OR

Example request

{
  "type": "SCRIPTED",
  "title": "Reschedule an appointment",
  "agentIds": [
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ],
  "graph": [
    {
      "type": "CUSTOMER_VERBATIM_TURN",
      "content": "Hi, I need to move my appointment.",
      "steps": [
        {
          "type": "AGENT_TURN",
          "content": "Offers alternative times",
          "steps": [
            {
              "type": "CUSTOMER_TURN",
              "content": "Takes the first slot"
            },
            {
              "type": "CUSTOMER_TURN",
              "content": "Asks for later in the week"
            }
          ]
        }
      ]
    }
  ]
}

Response

The created customer flow

Example response

{
  "data": {
    "happyPath": {
      "personaOverride": {
        "backstoryPrompt": "A busy professional calling during lunch break",
        "properties": {
          "age": 35,
          "zipCode": "94105",
          "occupation": "Software Engineer"
        },
        "phoneNumber": "+19312830919"
      }
    },
    "edgeCases": [
      {
        "personaOverride": {
          "backstoryPrompt": "A busy professional calling during lunch break",
          "properties": {
            "age": 35,
            "zipCode": "94105",
            "occupation": "Software Engineer"
          },
          "phoneNumber": "+19312830919"
        }
      }
    ]
  }
}

Changes

  • f747fc3e482cRevision changes
    • info

      added the new optional request property ///

    • info

      added the required property //// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property ///// to the response with the status

  • e32b31fc8f98Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status