Create an HHD flow
curl --request POST \
--url https://clarus-api.com/api/rf/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": false,
"definition": {
"steps": []
}
}
}
}
'import requests
url = "https://clarus-api.com/api/rf/flows"
payload = { "data": {
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": False,
"definition": { "steps": [] }
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'rf_flows',
attributes: {
code: 'PICK_STANDARD',
name: 'Standard Pick Flow',
flow_type: 'standard',
implementation_id: 1,
is_default: false,
definition: {steps: []}
}
}
})
};
fetch('https://clarus-api.com/api/rf/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": false,
"definition": {
"steps": []
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}HHD Flows
Create an HHD flow
Create a handheld device (HHD) flow for an implementation.
POST
/
api
/
rf
/
flows
Create an HHD flow
curl --request POST \
--url https://clarus-api.com/api/rf/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": false,
"definition": {
"steps": []
}
}
}
}
'import requests
url = "https://clarus-api.com/api/rf/flows"
payload = { "data": {
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": False,
"definition": { "steps": [] }
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'rf_flows',
attributes: {
code: 'PICK_STANDARD',
name: 'Standard Pick Flow',
flow_type: 'standard',
implementation_id: 1,
is_default: false,
definition: {steps: []}
}
}
})
};
fetch('https://clarus-api.com/api/rf/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": false,
"definition": {
"steps": []
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "rf_flows",
"attributes": {
"code": "PICK_STANDARD",
"name": "Standard Pick Flow",
"flow_type": "standard",
"implementation_id": 1,
"is_default": false,
"definition": { "steps": [] }
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
code | Yes | Unique code within the implementation (immutable after creation) |
name | Yes | Display name |
flow_type | Yes | standard, task, or loading |
implementation_id | Yes | The HHD implementation this flow belongs to |
is_default | No | Whether this is the default flow for the implementation |
definition | No | JSON definition of the flow steps |
HHD flows use the JSON:API typerf_flowsand live under the/api/rf/flowspath (known internally as RF flows).
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
Show child attributes
Show child attributes
Response
HHD flow created successfully
Show child attributes
Show child attributes
⌘I

