From a new account to a monitored flow

1. Create your organization and a project

   Create an account with your name and work email, confirm the email, and choose a password. A new organization starts with Personal free for 30 days, without a card. Name your organization, start a project, and invite colleagues as viewers, editors or owners. The project opens on a checklist that leads to a first run that tests something real.

2. Add your code or API

   Choose Add code or API. Paste a repository URL with a read-only token, add an OpenAPI or Swagger document by URL or upload, or point at a gRPC server with reflection. The scan takes seconds; endpoints, records, roles and pages show in the sidebar.

   Add the frontend too if you have one: pages give the steps their screen names.

3. Draw a flow

   Choose New flow and describe a journey in plain language, take a tour of what one role may do, or start empty and add steps from the endpoints menu.

   “A company admin logs in. The company admin sees the users and can create a user. An employee logs in. The employee sees the products and can order a product and update their order.”

   1. Company AdminPOST /realms/portal/protocol/openid-connect/token
   2. Company AdminGET /api/users
   3. Company AdminPOST /api/users
   4. EmployeePOST /realms/portal/protocol/openid-connect/token
   5. EmployeeGET /api/products
   6. EmployeePOST /api/orders
   7. EmployeePATCH /api/orders/:id

4. Run it against the mock

   Press Run flow. Each role signs in to the project’s mock backend, steps call their endpoints with ids from earlier replies, and the canvas marks every step as it passes or fails. Use Help me on a step to set up its body, keys and checks from the code, and Explain this failure on a step that failed.

5. Add an environment

   Under Manage environments, add your test or acceptance environment: its API URL, a sign-in preset, and a test account per role. Test connection signs every role in. Writes stay off until you allow them. If the environment only lets known addresses in, allow 88.198.26.110. For a private network, run a relay agent.

6. Run it on your environment

   Select the environment and run the flow again. Compare with… on the finished run puts it next to the mock run step by step, so differences between what the code says and what the environment does stand out.

7. Monitor it, and check every deploy

   Choose an interval to monitor the flow and add an alert channel: email, Microsoft Teams, Slack or a webhook. Then create a deploy hook for the environment and call it from your pipeline after each deploy. When you’re ready, run the access audit.

More detail: the product, integrations and the frequently asked questions.