ROroarkhq
Customer Flow

Get customer flow by ID

Changed on

Returns a customer flow with its happy path, edge cases, expectations and linked agents. Scripted flows also carry their step graph.

get/v1/customer-flow/{flowId}

Request

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

Path parameters

flowIdstring uuid required

Response

The requested 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 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