Forms Gateway (1.0.0)

Download OpenAPI specification:Download

Integration providers looking to build a Moveworks-compatible integration can implement an OpenAPI Specification. Once these APIs are defined, Moveworks can immediately integrate with your system

Smart Forms

Support Moveworks Smart Forms for your integration.

List Forms

Forms should be returned from this API in a deterministic order. Deterministic order is desired if we decide to use pagination. Anticipated load – Moveworks will call this endpoint to iterate over all forms provided by this endpoint once every 24 hours. This API is primarily used for ingestion.

SecuritybearerAuth or ApiKeyAuth

Request

query Parameters

offset required	integer <int64> Given a deterministically ordered list of articles, skips this many forms before returning form records
limit required	integer <int64> Number of forms to return in a single query. Recommended max: 100 records / request.

Responses

200

List of forms

default

There was an error. Please see our error documentation for details on what the errors mean. https://docs.moveworks.ai/gateway/errors/

get/forms

Request samples

Response samples

200
default

application/json

{"results": [{"id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
"image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
"domain": "IT",
"title": "Local Admin Access",
"description": "Lorem Ipsum",
"short_description": "Lorem Ipsum",
"url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
"last_updated_at": "2022-10-20T07:00:00Z",
"fields": [{"name": "permissions",
"label": "Which permissions do you need?",
"placeholder": "Enter text here.",
"help": "If you need help figuring out which access you need, ask your bot.",
"type": "LABEL",
"default_to_current_user": false,
"options": [{"label": "System Administrator",
"value": "system_administrator"
}
],
"required": false,
"visible": true
}
],
"dynamic_field_rules": [{"name": "Hide 2FA if write access not needed",
"logical": "AND",
"conditions": [{"field_name": "2fa_device",
"operator": "EQUALS",
"value": true
}
],
"actions": [{"field_name": "read_or_write",
"visible": false,
"required": true
}
]
}
]
}
]
}

Get Form By ID

Form with the requested ID should be returned from this API. Anticipated load – Moveworks may call this endpoint a few times every 24 hours. This API is primarily for sanity checks and debugging. Since ingestion happens once every 24 hours, we might want to verify if form submission failures are due to deviations between the local and remote versions.

SecuritybearerAuth or ApiKeyAuth

Request

path Parameters

formId

required

string

ID of form to return

Responses

200

A single form

default

There was an error. Please see our error documentation for details on what the errors mean. https://docs.moveworks.ai/gateway/errors/

get/forms/{formId}

Request samples

Response samples

200
default

application/json

{"id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
"image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
"domain": "IT",
"title": "Local Admin Access",
"description": "Lorem Ipsum",
"short_description": "Lorem Ipsum",
"url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
"last_updated_at": "2022-10-20T07:00:00Z",
"fields": [{"name": "permissions",
"label": "Which permissions do you need?",
"placeholder": "Enter text here.",
"help": "If you need help figuring out which access you need, ask your bot.",
"type": "LABEL",
"default_to_current_user": false,
"options": [{"label": "System Administrator",
"value": "system_administrator"
}
],
"required": false,
"visible": true
}
],
"dynamic_field_rules": [{"name": "Hide 2FA if write access not needed",
"logical": "AND",
"conditions": [{"field_name": "2fa_device",
"operator": "EQUALS",
"value": true
}
],
"actions": [{"field_name": "read_or_write",
"visible": false,
"required": true
}
]
}
]
}

Submit a Form

This API is primarily used for transactional activity. Performance will be essential. The following example assumes submission of the example form defined here. Anticipated load – Moveworks will call this endpoint every time a user submits a form through our native skill.

SecuritybearerAuth or ApiKeyAuth

Request

path Parameters

formId

required

string

ID of form to submit

Request Body schema: application/json

submitted_by required	string System ID (usually the email address) of the user who submitted this form.
fields	object This is a dictionary where they keys are the "field names" coming from the schema, and the value types are string, list of strings, and boolean. See the example.
	object

Responses

200

Successful form submission

default

There was an error. Please see our error documentation for details on what the errors mean. https://docs.moveworks.ai/gateway/errors/

post/forms/{formId}/submit

Request samples

application/json

{"submitted_by": "one@example.com",
"fields": {"requested_for": "two@example.com",
"permissions": ["system_administrator",
"network_administrator"
],
"read_or_write": "write",
"business_justification": "Lorem Ipsum",
"2fa_device": true,
"effective_date": "2022-10-20T07:00:00Z"
},
"form_metadata": {"name": "Local Admin Access",
"last_updated_at": "2022-10-20T07:00:00Z"
}
}

Response samples

200
default

application/json

{"ticket_id": "string"
}