Create a Request [Slack Automations]

POST

requests

slack

curl --request POST \
  --url https://api.siit.io/v1/requests/slack \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "slack_user_id": "<string>",
  "slack_message_link": "<string>",
  "slack_channel_id": "<string>",
  "custom_form_inputs": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}'

{
  "result": {
    "uid": "<string>",
    "title": "<string>",
    "description": "<string>",
    "submitted_from": "employee_portal",
    "author_uid": "<string>",
    "requested_by_uid": "<string>",
    "assignee_admin_uid": "<string>",
    "assignee_inbox_uid": "<string>",
    "target_uid": "<string>",
    "admin_permalink_url": "<string>",
    "mode": "private",
    "status": "open",
    "friendly_id": "<string>",
    "slack_channel_id": "<string>",
    "slack_thread_ts": "<string>",
    "slack_ts": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "completed_by_uid": "<string>",
    "tag_uids": [
      "<string>"
    ],
    "custom_form_inputs": [
      {
        "label": "<string>",
        "kind": "attachment",
        "value": "<string>"
      }
    ],
    "sla_data": {
      "first_replied_at": "2023-11-07T05:31:56Z",
      "first_completed_at": "2023-11-07T05:31:56Z"
    },
    "updated_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Introduction

Use this route if you’re plugging the request submission using Slack Automation.

This avoid you having to fetch the user UIDs and instead directly use Slack User IDs.

A sample project interacting with this API is available here.

Authorizations

Authorization

string

header

required

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

Body

application/json

title

string

required

slack_user_id

string

required

the Slack User ID of the requester

description

string

slack_message_link

string

An optional link referencing a Slack message

slack_channel_id

string

the Slack Channel ID (not needed if you use "slack_message_link")

custom_form_inputs

object[]

An optionnal array containing data attached to the request

Response

201

application/json

Request created

result

object

result.uid

string

The UID of the Request.

result.title

string

The title of the Request

result.description

string | null

The description of the Request

result.submitted_from

enum<string>

Describes how the request was submitted.

Available options:

employee_portal,

slack,

mail,

ms_teams,

admin_dashboard,

workflow,

public_api,

external

result.author_uid

string | null

The UID of the author.

result.requested_by_uid

string | null

The UID of the requester.

result.assignee_admin_uid

string | null

The UID of assigned User

result.assignee_inbox_uid

string | null

The UID of assigned Team inbox

result.target_uid

string | null

The UID of the associated Service/Application.

result.admin_permalink_url

string

The link to the request in Siit admin dashboard.

result.mode

enum<string>

Will be "public" only for Slack public threads (for now).

Available options:

private,

public

result.status

enum<string>

default:open

Request status

Available options:

open,

in_progress,

waiting,

resolved,

archived

result.friendly_id

string

A friendly ID (REQ-xx) where xx is a sequential number

result.slack_channel_id

string | null

ID of the channel where the request was created.

result.slack_thread_ts

string | null

Slack thread timestamp.

result.slack_ts

string | null

Slack timestamp.

result.completed_at

string | null

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

result.completed_by_uid

string | null

The UID of the user that completed this request.

result.tag_uids

string[] | null

Array containing the Request tags UIDs.

result.custom_form_inputs

object[] | null

Custom forms attached to this request.

result.sla_data

object | null

A Hash containing SLA data (only sent when Company has access to the feature).

result.updated_at

string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

result.created_at

string

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

Create a Request Retrieve a Request

curl --request POST \
  --url https://api.siit.io/v1/requests/slack \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "slack_user_id": "<string>",
  "slack_message_link": "<string>",
  "slack_channel_id": "<string>",
  "custom_form_inputs": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}'

{
  "result": {
    "uid": "<string>",
    "title": "<string>",
    "description": "<string>",
    "submitted_from": "employee_portal",
    "author_uid": "<string>",
    "requested_by_uid": "<string>",
    "assignee_admin_uid": "<string>",
    "assignee_inbox_uid": "<string>",
    "target_uid": "<string>",
    "admin_permalink_url": "<string>",
    "mode": "private",
    "status": "open",
    "friendly_id": "<string>",
    "slack_channel_id": "<string>",
    "slack_thread_ts": "<string>",
    "slack_ts": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "completed_by_uid": "<string>",
    "tag_uids": [
      "<string>"
    ],
    "custom_form_inputs": [
      {
        "label": "<string>",
        "kind": "attachment",
        "value": "<string>"
      }
    ],
    "sla_data": {
      "first_replied_at": "2023-11-07T05:31:56Z",
      "first_completed_at": "2023-11-07T05:31:56Z"
    },
    "updated_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

API Documentation

Request

Comment

User

Application

Tag

Workflow

Service

Create a Request [Slack Automations]

Introduction

Authorizations

Body

Response

API Documentation

Request

Comment

User

Application

Tag

Workflow

Service

​Introduction

Authorizations

Body

Response

Introduction