Editor helpers

#RMM devices (for the device step)

Address

https://<your-org>.brambleit.cloud/flows/api/devices

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Query parameters

Response 200

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/devices', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#A form's questions, for the "Form response submitted" trigger (as the flow's owner: their own access decides)

Address

https://<your-org>.brambleit.cloud/flows/api/bramble/form

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Query parameters

Response 200

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/bramble/form', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Pickers in Bramble steps (engine/nodes/bramble.js OPTION_SOURCES), as the flow's owner: ?flow=&source=psa.queues[&project=12]

Address

https://<your-org>.brambleit.cloud/flows/api/bramble/options

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Query parameters

Response 200

{
  "options": []
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/bramble/options', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Sends a "flows.test" event for the current user, to try event triggers

Address

https://<your-org>.brambleit.cloud/flows/api/events/test

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Request body JSON

Response 201

{
  "event_id": 7
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/events/test', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"message":"Saved"}),
});
const data = await res.json();

#When a schedule would next run, for the settings panel

Address

https://<your-org>.brambleit.cloud/flows/api/schedule/preview

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Request body JSON

Response 200

{
  "description": "string",
  "next": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/schedule/preview', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"schedule":"…"}),
});
const data = await res.json();

#Example data for an app event

Address

https://<your-org>.brambleit.cloud/flows/api/events/:type/sample

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Response 200

{
  "sample": {
    "event": "string",
    "…e.sample": "…"
  }
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/events/string/sample', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();