Search documentation

Search for a topic, a control, or an event type.

    Docs / Start here / Quickstart

    Build, test, and run your first workflow

    Build a workflow that summarizes a customer message, test it, and put it live on incoming events. You need an OAIZ account and a model you can use.

    Steps

    1. 1

      Describe what you want

      Open Chat and write what you want to automate in your own words. For example:

      “When a customer message arrives, summarize it in one sentence.”
    2. 2

      Review the jobs

      OAIZ adds the jobs to the canvas and marks them New. Open a job to see its prompt and output. To change something, say so in the same chat. Chat saves each change and shows Keep changes and Reject changes. Reject changes restores the version before that change.

    3. 3

      Choose a test event

      Open the menu beside Run workflow and choose Change event. Pick an event that has a message, or create one in Events with these properties:

      Event properties
      {
        "message": "Please change my billing address to 12 Example Street."
      }
    4. 4

      Run the test

      Choose Run workflow and open the result of the job. The summary should mention the new billing address, 12 Example Street. The wording can change from run to run.

    5. 5

      Keep it as a draft

      Chat has already saved the workflow as a draft. A draft does not run on live events, so you can keep editing and testing it safely.

    6. 6

      Go live

      Choose Go live. The live version now starts each time a new event of its type arrives. Later edits go into a draft and do not change what runs until you choose Go live again.

    7. 7

      Send a live event

      Open Activity, then Events, and choose Add Custom Event. Use the event type your workflow listens for, add a message property, and choose Publish Event.

      In production, the event comes from a connected service or from your own system through the API. Events explains both.

    8. 8

      Watch it run

      Open Logs to see the run and the output of each job. The page of the event in Events also lists the runs it started.

      To stop live runs, choose Pause. To change the workflow, edit the draft, test it with Run workflow, and choose Go live again.

    Troubleshooting

    Run workflow is disabled
    Choose an input event in the menu beside Run workflow.
    The job does not run
    Check that the event type matches the trigger of the job.
    The summary is empty
    Check that the event has a message property and that the prompt reads that property.
    A live event starts nothing
    Check that the workflow is live and not paused, and that the event type matches the one in the trigger.