Forms

Create and manage forms that can trigger graph executions.

createForm

Create a new form that can trigger graphs. The optional "schema" parameter defines the form's JSON Schema for input fields.

POST

Usage:

const result = await swirls.client.forms.createForm({
  projectId: '...',
  name: '...',
  label: '...',
})

Input:

Output:

getForm

Get a form by ID

GET

Usage:

const result = await swirls.client.forms.getForm({
  id: '...',
})

Input:

Output:

updateForm

Update a form. The "schema" parameter defines the form's JSON Schema for input fields.

PUT

Usage:

const result = await swirls.client.forms.updateForm({
  id: '...',
})

Input:

Output:

deleteForm

Delete a form

DELETE

Usage:

const result = await swirls.client.forms.deleteForm({
  id: '...',
})

Input:

listForms

List all forms in a project

GET

Usage:

const result = await swirls.client.forms.listForms({
  projectId: '...',
})

Input:

Output:

listTriggersForForm

GET

Usage:

const result = await swirls.client.forms.listTriggersForForm({
  formId: '...',
})

Input:

Output:

listFormSubmissions

GET

Usage:

const result = await swirls.client.forms.listFormSubmissions({
  formId: '...',
})

Input:

Output:

submitForm

Submit data to a form. The form must be enabled. Triggers associated with the form will be executed. Returns execution IDs for any triggered graphs.

POST

Usage:

const result = await swirls.client.forms.submitForm({
  formId: '...',
  data: {},
})

Input:

Output: