Connections

#Kinds of connection

Address

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

Requires

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

Response 200

{
  "types": [
    {
      "type": "string",
      "label": "Example label",
      "icon": null,
      "help": null,
      "use": null,
      "fields": []
    }
  ]
}

Example request

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

#?type=a,b ?flow=<id> → only ones that flow could use

Address

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

Requires

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

Query parameters

Response 200

{
  "connections": [
    {
      "…credentials.summary(r, u": "…",
      "can_edit": true
    }
  ]
}

Errors

Example request

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

#Editing form: the non-secret fields, and which secrets are set

Address

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

Requires

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

Path parameters

Response 200

{
  "…credentials.summary(row,": "…",
  "data": [],
  "secrets_set": null,
  "used_by": null
}

Errors

Example request

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

#Create a connection

Address

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

Requires

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

Request body JSON

Response 201

Example request

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

#Update a connection

Address

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

Requires

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

Path parameters

Request body JSON

Response 200

Errors

Example request

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

#Delete a connection

Address

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

Requires

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

Path parameters

Query parameters

Response 200

{
  "ok": true
}

Errors

Example request

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

#A mailbox connection's folders (for the IMAP trigger's folder pickers), if the flow (?flow=) may use the connection

Address

https://<your-org>.brambleit.cloud/flows/api/connections/:id/folders

Requires

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

Path parameters

Query parameters

Response 200

{
  "folders": []
}

Errors

Example request

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

#Test a connection: a saved one (:id, optionally with changed fields) or an unsaved one (body.type + body.data)

Address

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

Requires

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

Request body JSON

Response 200

true

Errors

Example request

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