@picked/client 0.0.101-next.2 → 0.0.101-next.3

package/dist/docs/reference/dashboard/experiences.mdx

@@ -1,51 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Experiences
-
-An experience is personalized content that Picked serves to the visitors on your
-site. Each experience points at a component that you register in your application.
-
-An experience is either a **Flow** or a **Page**. A **Flow** is an interactive
-experience of more than one step, and the browser renders it. This page covers the
-flow. A **Page** is a standalone experience that the server renders from CMS content,
-for a landing page where the search rank matters. See [Pages](/reference/dashboard/content/pages) for
-that kind.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences"
-  alt="The experiences list for a workspace on the Picked dashboard"
-/>
-
-## Experience settings
-
-Choose no node on the canvas, or click the canvas background, to open the experience
-inspector in the right panel.
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Component Name**: The identifier that points this experience at a component in your
-application.
-
-**Condition**: An optional condition. When you set it, the experience starts only for
-a visitor who matches the condition. See
-[Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how to write one. Keep it
-blank to start the experience for every visitor.
-
-**Initialize Open**: An optional condition that controls whether the experience opens
-by itself when the page loads. When it is blank, the experience loads but stays
-closed until something opens it.
-
-## Experience list
-
-The experiences list shows every experience in the current project. Click an
-experience to open it in the flow builder.
-
-## Related
-
-- [About pages and flows](/explanation/pages-and-flows) — Page or Flow.
-- [How to create an experience](/how-to/create-an-experience)

package/dist/docs/reference/dashboard/external-apis.md

@@ -1,169 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# External APIs
-
-An external API is an origin that this project's workflows are allowed to call with the
-**External API** node. For the steps to register an API that uses OAuth2, refer to
-[How to register an API that uses OAuth2](/how-to/register-an-api-that-uses-oauth2).
-
-## Registration
-
-| Field        | Rule                                                                                                                                                                                                                                                          |
-| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Display name | Required. 1 to 120 characters. For you only; it does not go out with the request.                                                                                                                                                                             |
-| Origin       | Required. The scheme, the host and the optional port, with no path, query, fragment or sign-in details. `http` or `https` only, on port 80 or 443. Must not point at a private, loopback or link-local address. One live registration per origin per project. |
-| Credential   | None, an authorization header, or an OAuth2 credential. Each secret is encrypted and is never returned.                                                                                                                                                       |
-
-An authorization header is a header name and a value. The dashboard shows the header name
-and a mask. An OAuth2 credential gets an access token for each call. Refer to
-[OAuth2 credential](#oauth2-credential). When you set one kind of credential, Picked removes
-the other kind.
-
-On a registration with an OAuth2 credential, the dashboard does not show the authorization
-header. Remove the OAuth2 credential before you set a header.
-
-To change an origin, delete the registration and register the new origin. The origin is
-the registration's identity.
-
-A preset sets the display name, the origin and an OAuth2 credential for a provider. Refer to
-[OAuth2 credential](#oauth2-credential).
-
-## OAuth2 credential
-
-An OAuth2 credential gets an access token from the provider's token URL. Picked sends the
-header scheme, a space and the access token in the header with each request.
-
-| Setting               | Default         | Rule                                                                                                                                                                                                                                                                                                     |
-| --------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Grant                 | Refresh token   | `Refresh token` or `Client credentials`.                                                                                                                                                                                                                                                                 |
-| Token URL             | —               | Required. An `https` URL with no fragment. The query must not contain `grant_type`, `client_id`, `client_secret`, `refresh_token` or `code`. Picked checks the URL as it checks an origin. Picked does not register its origin.                                                                          |
-| Client ID             | —               | Required. 1 to 512 characters.                                                                                                                                                                                                                                                                           |
-| Client secret         | —               | Required. Encrypted, and never returned. When you edit the credential, an empty field keeps the stored client secret. If you change the token URL, the client ID or the client authentication, enter the client secret again.                                                                            |
-| Refresh token         | —               | Required for the refresh token grant. The client credentials grant does not use one. Encrypted, and never returned. When you edit the credential, an empty field keeps the stored refresh token. If you change the token URL, the client ID or the client authentication, enter the refresh token again. |
-| Client authentication | Form body       | The client ID and the client secret go in the form body, or in an `Authorization: Basic` header.                                                                                                                                                                                                         |
-| Token parameters      | None            | Up to 20 more form parameters, such as `scope`. `grant_type`, `client_id`, `client_secret`, `refresh_token` and `code` are not permitted.                                                                                                                                                                |
-| Header name           | `Authorization` | The header that holds the access token.                                                                                                                                                                                                                                                                  |
-| Header scheme         | `Bearer`        | The word before the access token, such as `Zoho-oauthtoken`. No spaces.                                                                                                                                                                                                                                  |
-| 401 rule              | None            | A path in the JSON body of a 401 answer, and 1 to 20 values at that path that show an expired token. Put a dot between the parts of the path, for example `code` or `data.0.code`. A part that is a number identifies an item in a list. With no rule, each 401 shows an expired token.                  |
-
-The Zoho CRM preset sets the display name `Zoho CRM` and the origin of the API for the
-region, such as `https://www.zohoapis.com.au`. It also sets an OAuth2 credential. The
-credential has the token URL for the region, `Form body`, `Zoho-oauthtoken`, and a 401 rule
-of `code` with the value `INVALID_TOKEN`. On the page of a registered external API, the preset sets only the
-OAuth2 credential.
-
-### Access tokens
-
-- Picked sends the token request as a `POST` with a form body, so no secret is in a URL.
-- Picked uses an access token until 60 seconds before it expires.
-- Picked reads the lifetime from `expires_in_sec`, or else from `expires_in`. Picked keeps
-  a token with no lifetime for one hour.
-- Picked counts an answer as a success when its JSON body has an `access_token`, for all
-  statuses.
-- A `refresh_token` in the answer replaces the stored refresh token.
-- One token request at a time runs for each credential. Other calls use the token that it
-  gets.
-- After a token request fails with `credential_refresh_failed`, Picked sends no token
-  request for 60 seconds. Calls in that time fail with `credential_refresh_failed`.
-- Picked uses a stored access token for all values of `timeoutMs`.
-- The token request, and the wait for a token request of another call, use time from the
-  node's `timeoutMs`. Each stops while 5 seconds remain. Picked starts a token request only
-  when 6 seconds or more remain. A token request stops after 10 seconds.
-- When the node's time stops a token request, other calls can send a token request
-  immediately.
-
-### A 401 answer
-
-Picked gets a new token and sends the request again when these are all true:
-
-- The API answered 401.
-- The token is older than 60 seconds.
-- The credential has no 401 rule, or the rule applies to the body of the answer.
-
-The second request has the same `Idempotency-Key`. Its answer is the result of the node.
-
-If Picked cannot get a new token, the node fails with `credential_rejected` or
-`credential_refresh_failed`. Then `nodes.<node-id>.status`, `ok` and `body` keep the 401
-answer.
-
-## Node arguments
-
-| Argument            | Default                                                              | Rule                                                                                                                 |
-| ------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `method`            | —                                                                    | Required. `GET`, `HEAD`, `POST`, `PUT`, `PATCH` or `DELETE`.                                                         |
-| `url`               | —                                                                    | Required. The full address. Its origin must be registered to this project.                                           |
-| `headers`           | none                                                                 | A JSON object of headers to send. Picked refuses a credential here when you save.                                    |
-| `body`              | none                                                                 | The JSON body. Used by `POST`, `PUT` and `PATCH`.                                                                    |
-| `timeoutMs`         | 10000                                                                | 1000 to 30000. The time that the whole call has, with every retry.                                                   |
-| `retry`             | on for `GET`, `HEAD`, `PUT` and `DELETE`; off for `POST` and `PATCH` | Whether to send the request again after a failed connection, an unknown host, or a status of 408, 429 or 500 to 599. |
-| `failOnErrorStatus` | on                                                                   | Whether a status outside 200 to 299 fails the node.                                                                  |
-| `recordBody`        | on                                                                   | Whether to record the answer's body.                                                                                 |
-
-## Output
-
-| Name            | Value                                                                    |
-| --------------- | ------------------------------------------------------------------------ |
-| `status`        | The HTTP status.                                                         |
-| `ok`            | True for a status from 200 to 299.                                       |
-| `body`          | The parsed JSON answer, or null when it is not JSON or was not recorded. |
-| `bodyTruncated` | True when the answer was too large to record in full.                    |
-| `durationMs`    | The time the call took.                                                  |
-
-## Limits
-
-- The request body is limited to 1 MiB.
-- The recorded answer is limited to 256 KiB. A larger answer sets `bodyTruncated`.
-- Picked records the status that asks the caller to redirect. Picked does not go to the
-  new address.
-- Picked sends a request three times at most. Picked waits longer before each retry, and
-  waits for the time that a `Retry-After` header gives.
-- A timeout uses all of `timeoutMs`, so Picked does not send the request again after a
-  timeout.
-
-## Errors
-
-When the node fails, the run stops at the node. If the call fails and an edge leaves the
-node's error exit, the run continues on that edge. These failures stop the run at the
-node, with or without that edge:
-
-- A required argument has no value.
-- An argument has a value that the tool does not accept. For example, the value has the
-  wrong type, `method` is not one of the six methods, or `timeoutMs` is not from
-  1000 to 30000.
-- A template cannot be rendered.
-- The workflow does not have a scope that the tool needs.
-- An error occurs in Picked.
-
-A later node reads why the call failed from `nodes.<node-id>.error`:
-
-| Field       | Value                                                                                            |
-| ----------- | ------------------------------------------------------------------------------------------------ |
-| `code`      | `http_failed`.                                                                                   |
-| `message`   | The node, the tool and the message from the table below.                                         |
-| `reason`    | The reason from the table below.                                                                 |
-| `retryable` | True when the same request can pass at a later time.                                             |
-| `status`    | The HTTP status, for the reason `error_status`. Also for a credential reason after a 401 answer. |
-
-After an error status, `nodes.<node-id>.status`, `ok` and `body` also keep the answer.
-
-| Reason                      | Message ends with                                           | Retryable                   | When                                                                                                                                                                                                   |
-| --------------------------- | ----------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `error_status`              | `the API answered <status>`                                 | For 408, 429 and 500 to 599 | The status was outside 200 to 299, and `failOnErrorStatus` is on.                                                                                                                                      |
-| `timeout`                   | `no answer within the node's timeout`                       | Yes                         | Nothing answered within `timeoutMs`.                                                                                                                                                                   |
-| `transport`                 | `the request could not be delivered`                        | Yes                         | The connection failed.                                                                                                                                                                                 |
-| `unresolvable`              | `the destination hostname did not resolve`                  | Yes                         | No address was found for the host.                                                                                                                                                                     |
-| `refused`                   | `the destination was refused`                               | No                          | The URL points at a private, loopback or link-local address.                                                                                                                                           |
-| `refused`                   | `no external API is registered for <origin>`                | No                          | The URL's origin has no live registration in this project.                                                                                                                                             |
-| `request_too_large`         | `the request body is over 1 MiB`                            | No                          | The body is larger than the limit.                                                                                                                                                                     |
-| `invalid_request`           | `the request is not one the tool can send`                  | No                          | The arguments do not make a valid request.                                                                                                                                                             |
-| `invalid_request`           | `the URL is not one the tool can send`                      | No                          | The tool cannot send to the URL.                                                                                                                                                                       |
-| `invalid_headers`           | The header that Picked refused                              | No                          | A header name or value is not valid for HTTP.                                                                                                                                                          |
-| `credential_unavailable`    | `the credential for this external API is unavailable`       | No                          | Picked cannot read a secret of the registration's credential.                                                                                                                                          |
-| `credential_rejected`       | `the token endpoint refused this external API's credential` | No                          | The token endpoint answered `invalid_client`, `invalid_grant`, `invalid_code`, `invalid_client_secret` or `unauthorized_client`.                                                                       |
-| `credential_refresh_failed` | `no access token could be fetched for this external API`    | Yes                         | The token endpoint did not answer in time, or Picked cannot reach it. Or the token endpoint answered with no token, or a token request failed less than 60 seconds before. Or the node's time ran out. |
-
-Picked also refuses a workflow when you save it if a node holds a credential in
-`headers`. Register the external API, and put the credential on the registration.

package/dist/docs/reference/dashboard/features.mdx

@@ -1,154 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Feature flags
-
-A feature flag lets you run an A/B test and roll a change out in stages. It controls
-which visitors see a change to your site, and you deploy no code.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/features"
-  alt="The feature flags list for a workspace on the Picked dashboard"
-/>
-
-## Keys
-
-Each feature flag has a unique key. Your application uses this key to check whether
-Picked allocates a visitor to the feature flag. You set the key when you create the
-feature flag, and you cannot change it later.
-
-## Types
-
-Each feature flag has a type. You set the type when you create the feature flag, and you
-cannot change it later.
-
-| Type | What your site receives | Groups |
-| --- | --- | --- |
-| **Boolean** | `true` or `false` | Two |
-| **Text** | A string that you write, or `false` for the control group | Two or more |
-
-Choose **Boolean** for one change against no change. Choose **Text** when you must test
-several changes at the same time, and each change needs its own group.
-
-## Set the allocation
-
-Set the allocation from the detail page of the feature flag:
-
-| Control | What it does |
-| --- | --- |
-| **Enabled** | Whether Picked allocates a visitor to the feature flag. A disabled feature flag allocates nobody, and it records nothing. See [Disable a feature flag](#disable-a-feature-flag). |
-| **Weight** | The percentage of visitors that Picked allocates to a Boolean feature flag, from 0 to 100. |
-| **Variants** | The groups of a Text feature flag, and the traffic that each one receives. See [Variants](#variants). |
-| **Description** | An internal note about what the feature flag tests. |
-
-A Boolean feature flag has one weight. For each visitor it gives one of two outcomes:
-allocated, or not allocated. A weight of 30 allocates 30% of your visitors. The other
-70% stay unallocated. A weight of 0 allocates nobody. A weight of 100 allocates
-everybody.
-
-## Variants
-
-A Text feature flag has a table of variants. Each row is one group of visitors:
-
-| Column | What it does |
-| --- | --- |
-| **Name** | A label for the variant. It appears in your reports. You can change it at any time. |
-| **Value** | The string that your site receives for a visitor in this variant. |
-| **Weight** | The share of traffic for this variant, against the other rows. |
-
-The first row is **Control**. Picked always sends `false` to a visitor in the control
-group, and you cannot remove the row, move it, or change its value. It takes a weight like
-any other row.
-
-The weights are shares, and not percentages. Picked reduces them to their smallest whole
-numbers, so `10 : 10 : 20` and `1 : 1 : 2` are the same split. The percentage beside each
-row shows the traffic that the variant receives.
-
-Choose **Even split** to give every variant the same weight.
-
-:::info
-The order of the rows is the order that you read them in. It has no effect on the
-allocation, so you can move a row and no visitor changes group.
-:::
-
-## How Picked allocates a visitor
-
-The allocation is deterministic. It derives from the visitor ID and from the ID of the
-feature flag. A Boolean feature flag then compares that value against the weight, and a
-Text feature flag compares it against the range of each variant. Each feature flag gets its
-own value, so tests that run at the same time are independent. See
-[About feature flag allocation](/explanation/feature-flag-allocation).
-
-## Disable a feature flag
-
-A disabled feature flag allocates nobody, and it records nothing. The difference
-from a weight of 0 matters for your reports. The visitor is **not in the test at
-all**, and the visitor is not in the control group.
-
-The SDK does not evaluate a disabled feature flag. It stores no decision in the
-browser of the visitor, and it reports no decision to your analytics. Such a feature
-flag is absent from the feature list on every analytics event.
-
-An experience whose condition points at a disabled feature flag behaves as though
-the visitor is not in the test. The condition reads as not allocated, and Picked
-records no assignment.
-
-This state is temporary, and it discards no decision that Picked made already. A
-visitor who was allocated before keeps that decision in the browser. When you enable the
-feature flag again, Picked continues from that decision, and the visitor stays in the
-group they were already in.
-
-:::note
-Expect a step change in your reports when you disable a feature flag: fewer feature
-flags for each visitor, and fewer decision events. That is the feature flag that drops
-out, and you lose no data.
-:::
-
-A disabled feature flag stays visible in the developer tools, and a
-[URL override](/reference/sdk/features#overrides-in-the-url) still turns one on for QA.
-
-## Feature flag versions
-
-Each feature flag has a version number, and it starts at 1. The SDK caches an
-allocation decision in the browser of the visitor under a key, and the version is part
-of that key. The version does nothing else, and it is not an input to the allocation
-value. When you increment the version, the SDK discards those cached decisions. It
-then evaluates every visitor again on the next page load.
-
-### What happens when you increment the version
-
-- **The SDK invalidates the cached decisions.** The cache key holds the version, so the
-  old entry no longer matches and the feature flag counts as undecided.
-- **Picked evaluates each visitor against the current weight.** The allocation is
-  deterministic and the version is not one of its inputs, so the same visitor against
-  an unchanged weight gives the same result.
-- **You cannot reverse this.** There is no way to decrement a version.
-
-:::note
-The new version does not move your visitors between groups. It clears the cached
-decisions and runs the allocation again. With an unchanged weight, everybody lands
-where they were before. Change the weight to move your visitors.
-:::
-
-### When to increment
-
-Increment the version after you change the weight. Do this when you want Picked to
-evaluate an allocated visitor again against the new weight, and not to use the cached
-decision.
-
-### When not to increment
-
-To apply a weight change only to a visitor that Picked does not allocate yet, change
-the weight and leave the version as it is. An allocated visitor keeps the current
-allocation.
-
-## Related
-
-- [About feature flag allocation](/explanation/feature-flag-allocation)
-- [How to run an A/B test](/how-to/run-an-ab-test)
-- [How to read a feature flag](/how-to/read-a-feature-flag)
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)

package/dist/docs/reference/dashboard/fields.mdx

@@ -1,106 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../components/Screenshot'
-
-# Fields
-
-A field is a data input that a visitor sees inside a step. A field collects
-information such as a name, an email address, a preference, or a choice.
-
-This page covers the experience field, which collects visitor input. An experience
-field is not the same as a content field. A content field is part of the schema of a
-CMS layout. See [Models](/reference/dashboard/content/models) for those.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/fields"
-  alt="The fields list for a workspace on the Picked dashboard"
-/>
-
-## Field types
-
-A field has one of many types. These are the common ones:
-
-`TEXT`: A string input. Use it for a name, an email address, or free text.
-
-`NUMBER`: A numeric input. Use it for a quantity, a rating, or an age.
-
-`BOOLEAN`: A true or false toggle. Use it for a checkbox or for consent.
-
-`OBJECT`: A structured data input. Use it for data that holds other data.
-
-## Options
-
-**Name**: The name that the dashboard shows. Your visitors do not see it.
-
-**Key**: The identifier for your application. You set it once and you cannot change
-it. Your visitors do not see it.
-
-**Label**: The label that a visitor sees next to the field.
-
-**Placeholder**: The hint text that the input shows while it is empty.
-
-**Description**: A longer description of what the field is for. The dashboard shows
-it. Your visitors do not see it.
-
-**Help Text**: Text below the field that helps your visitors.
-
-**Default Value**: The value that the field holds when it loads.
-
-## Validation
-
-**Required**: When this is on, a visitor must fill in the field before the flow can
-continue.
-
-**Validation rules**: Conditions for a constraint such as a smallest value, a largest
-value, or a pattern. See [Condition Builder](/reference/dashboard/flow-builder/condition-builder) for how
-to build a validation rule.
-
-## More than one value
-
-Turn on **Multiple** to let a visitor send more than one value for the field. This is
-useful for an input that takes several choices, or for a field of tags.
-
-## Choices
-
-For a field with a fixed set of choices, such as a dropdown or a set of radio
-buttons, add options. Each option has a value, and the response carries that value.
-
-Each option can also carry a condition. When you set one, the option appears only to
-a visitor who matches the condition. See
-[Condition Builder](/reference/dashboard/flow-builder/condition-builder) for more detail.
-
-## Privacy
-
-A field captures nothing until you permit it. Two checkboxes control where the value of
-a field can go. Both start off.
-
-| Checkbox | What it does when you turn it on |
-| --- | --- |
-| **Remember in the browser** | The SDK keeps the value on the device of the visitor. The value is available after a page load. |
-| **Send to analytics** | Picked puts the value in your analytics events. |
-
-Each checkbox is independent of the other.
-
-A new field that you leave alone sends no value to your analytics. It writes no value to
-the browser. Keep both checkboxes off for sensitive data such as a password, a tax
-number, or a payment detail.
-
-Never turn on **Send to analytics** for personal data. A name, an email address, a phone
-number, a home address, or an identity number must not reach your analytics.
-
-Neither checkbox stops the flow from the use of the value inside the page. A field that
-captures nothing still holds its value there. The flow validates the step with it, and it
-evaluates the conditions after the step with it. The checkboxes control what leaves the
-page.
-
-## Related
-
-- [How to add a step, a field, an action, or a condition](/how-to/add-a-step-field-or-action)
-
-- [How to validate a field](/how-to/validate-a-field)
-- [How to write a condition](/how-to/write-a-condition) — for a validation rule or an
-  option condition.
-- [SDK fields](/reference/sdk/fields) — the `policies` object.

package/dist/docs/reference/dashboard/flow-builder/canvas.mdx

@@ -1,58 +0,0 @@
----
-type: reference
-layout: docs
----
-
-import { Screenshot } from '../../../../../components/Screenshot'
-
-# Flow builder
-
-The flow builder is a visual editor for an experience flow. You drag a block onto a
-canvas, connect the blocks with arrows, and set the options of each node in an
-inspector panel.
-
-<Screenshot
-  route="/{orgSlug}/{projectId}/workspaces/{workspaceId}/experiences/{experienceId}"
-  alt="The flow builder with the library, canvas, and inspector panels"
-/>
-
-## Layout
-
-The flow builder has three panels, from left to right.
-
-**Library**, on the left: it lists every step, action, condition, and field in
-your project. Drag an item from here onto the canvas.
-
-**Canvas**, in the middle: the area where you build your flow. A node stands for a
-block. An arrow stands for a connection between two blocks.
-
-**Inspector**, on the right: it shows the options of the node that you choose. When
-you choose no node, it shows the settings of the experience.
-
-## Panel controls
-
-Drag a divider between two panels to change their size. Press `Cmd/Ctrl+\` to turn
-both side panels on and off. Press `Cmd/Ctrl+Shift+\` to turn the inspector on and
-off.
-
-## Move around the canvas
-
-**Zoom**: scroll to make the view larger or smaller.
-
-**Pan**: choose the hand tool with `H`, then drag. You can also hold `Space` and
-drag. A drag with the middle mouse button also pans.
-
-**Choose tool**: press `V` to go back to the default tool.
-Click to choose a node. Drag on empty space to choose every node inside a rectangle.
-
-## Auto-layout
-
-Click the auto-layout button in the toolbar. The flow builder then arranges every
-node into a clean hierarchy. This is useful after you add many nodes, and when the
-canvas becomes messy.
-
-## Related
-
-- [How to build a flow](/how-to/build-a-flow) — add, connect, and branch.
-- [Keyboard shortcuts](/reference/dashboard/flow-builder/keyboard-shortcuts)
-- [Nodes](/reference/dashboard/flow-builder/nodes)

package/dist/docs/reference/dashboard/flow-builder/condition-builder.md

@@ -1,57 +0,0 @@
----
-type: reference
-layout: docs
----
-
-# Condition builder
-
-The condition builder is a visual rule editor, and the dashboard uses it in several
-places. With it you define a rule and you write no code.
-
-## Where it appears
-
-The dashboard uses the condition builder here:
-
-- **Condition nodes** — they set which branch the flow takes in the
-  [flow builder](/reference/dashboard/flow-builder/canvas).
-- **Experience conditions** — they control when an experience starts for a visitor.
-- **Initialize open conditions** — they control when an experience opens by itself as
-  the page loads.
-- **Field option conditions** — they show or hide one option, and the state of the
-  visitor decides which.
-
-## Rule structure
-
-The builder holds your rules in groups. Each group uses **AND** or **OR**. With
-**AND**, every rule must match. With **OR**, one rule must match.
-
-A single rule has three parts:
-
-1. **Field** — the data source to evaluate.
-2. **Operator** — how to compare. Examples are equals, not equals, greater than, and
-   contains.
-3. **Value** — the value to compare against.
-
-You can put a group inside another group to build a larger rule. An example is an AND
-group that holds two OR groups.
-
-## Data sources
-
-A rule can point at these data sources:
-
-**Responses** — the values that your visitors send through the form fields of the
-current experience. Each field that you create in your project appears here under its
-name.
-
-**Actions** — the actions that ran during the flow.
-
-**Feature flags** — the state of each feature flag in your project. Use it to take a
-branch on whether Picked allocates a visitor to a flag.
-
-**Location** — the parts of the current page URL of the visitor. These are the
-pathname, the search parameters, the hostname, and the hash.
-
-## Related
-
-- [How to write a condition](/how-to/write-a-condition) — a worked example.
-- [About conditions and the logic engine](/explanation/conditions-and-the-logic-engine)