Using forms
Forms are always linked to a ticket. Each ticket can contain one (not multiple) forms. Triggers, crons or API actions can specify which type of form belongs to the ticket.
Get available forms (list)
GET
https://account.omnidesk.com/api/v2/form
Get all information of a form
GET
https://account.omnidesk.com/api/v2/form/1
No further parameters required in the request. Just specify the form id in the path to get information on the form, like the fields it contains.
This might be the moment you want to create a ticket and specify what type of form you want to use for the ticket. See the ticket documentation. For the next step you can use the ticket ID in the response to save form fields to the ticket.
Save form field
PUT
https://account.omnidesk.com/api/v2/form/saveFormFields
This endpoint allows you to save content to a form.
Request Body
Name | Type | Description |
---|---|---|
fields[1]['formFieldValue'] | string | value2 |
fields[1]['formFieldID'] | integer | 15 |
fields[0]['formFieldValue'] | string | value1 |
fields[0]['formFieldID'] | integer | 12 |
ticketID | integer |
Get ticket form field values
GET
https://account.omnidesk.com/api/v2/form/getFormForTicket?ticketID=1
This endpoint will return the form field information from a single ticket. The data that was filled in can be found in two different keys: - For select fields (dropdown fields) it can be found under they key "selectedFields" - For other fields (text fields etc) it can be found under the key "values" For the selectedFields the formFieldID will match the formFieldID's under fields.options.
Path Parameters
Name | Type | Description |
---|---|---|
ticketID | integer |
Last updated