Skip to main content
POST
Create a Request

Create a request

Send title_markdown, submitted_from, and requested_by. The requested_by value is the requester’s user UID. author defaults to the API key’s owner; if supplied, it must match requested_by or identify an admin user. For example, send this JSON body to POST https://api.siit.io/v1/requests. Replace the user UID with one from your workspace:
Use target to select a service. Relationship fields take UIDs, not nested objects.

Custom forms

Add custom_form_inputs to the request body to submit arbitrary fields, native service form fields, or a mixture of both.

Arbitrary fields

Use a label and a value to store extra information:
Arbitrary fields cannot be used as native custom-form fields in workflow conditions.

Native service fields

  1. Retrieve the target service with GET /v1/services/{uid}.
  2. Read its custom_form_input_configuration array to find each field’s UID, kind, options, and whether it is required or allows multiple values.
  3. Set target to the service UID and include the field values in custom_form_inputs.
Submitting at least one native field triggers validation of the whole service form. Include every required field, or request creation fails. For a service with a text field and a selection field that allows multiple values, the body could be:
Replace all UIDs and option values with those returned by your service. Match the JSON value to the field configuration: Files cannot be submitted as native custom-form values through this API. Request-level attachments are a separate field; see the request body schema below. Workflows targeting native fields run on normal request creation. Batch imports do not trigger workflows.

Usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title_markdown
string
required

The title as markdown. Takes precedence over title when both are provided.

submitted_from
enum<string>
required
Available options:
employee_portal,
slack,
mail,
ms_teams
requested_by
string
required

can be different from the author UID (e.g Admin submitting on behalf)

title
string
deprecated

please use "title_markdown" instead

description
string
deprecated

please use "description_markdown" instead

description_markdown
string

The description as markdown. Takes precedence over description when both are provided.

author
string

must be equal to requester UID or reference an admin user. Defaults to the token owner when omitted.

can be provided along submitted_from=slack to link directly to a specific message. Note that if bot has a specific public request configuration for the channel then the request mode will be "public".

status
enum<string>
Available options:
open,
in_progress,
waiting,
resolved,
archived
priority
enum<string>
Available options:
low,
medium,
high,
urgent
tags
string[]
associated_apps
string[]
associated_equipments
string[]
target
string
assignee_admin
string
assignee_inbox
string
custom_form_inputs
(Arbitrary input (by label) · object | Native input (by uid) · object)[]

An optional array containing data attached to the request. Each item must include either "uid" (native input) or "label" (arbitrary input), plus "value".

A custom form input item for request creation. Either "label" (arbitrary input) or "uid" (native input from service configuration) must be provided.

attachments
object[] | null

Files to download and attach.

Response

Request created

result
object