@itentialopensource/adapter-slack
Version:
This adapter integrates with system Slack
1,420 lines • 975 kB
JSON
{
"basePath": "/api",
"definitions": {
"defs_app_id": {
"pattern": "^A[A-Z0-9]{8}$",
"title": "App ID",
"type": "string"
},
"defs_bot_id": {
"pattern": "^B[A-Z0-9]{8}$",
"title": "Bot User ID",
"type": "string"
},
"defs_channel": {
"pattern": "^[CGD][A-Z0-9]{8}$",
"title": "Channel-like conversation ID",
"type": "string"
},
"defs_channel_id": {
"pattern": "^[C][A-Z0-9]{8}$",
"title": "Channel ID",
"type": "string"
},
"defs_channel_name": {
"title": "Name of a channel",
"type": "string"
},
"defs_comment_id": {
"pattern": "^Fc[A-Z0-9]{8}$",
"title": "File Comment ID",
"type": "string"
},
"defs_dm_id": {
"pattern": "^[D][A-Z0-9]{8}$",
"title": "Direct Message Channel ID",
"type": "string"
},
"defs_file_id": {
"pattern": "^[F][A-Z0-9]{8}$",
"title": "File ID",
"type": "string"
},
"defs_group_id": {
"pattern": "^[G][A-Z0-9]{8}$",
"title": "Private Channel ID",
"type": "string"
},
"defs_invite_id": {
"title": "Invite ID for an external shared channel",
"type": "integer"
},
"defs_ok_false": {
"enum": [
false
],
"title": "default failure response",
"type": "boolean"
},
"defs_ok_true": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"defs_pinned_info": {
"additionalProperties": {
"additionalProperties": true,
"properties": {
"pinned_by": {
"$ref": "#/definitions/defs_user_id"
},
"pinned_ts": {
"type": "integer"
}
},
"required": [
"pinned_by",
"pinned_ts"
],
"type": "object"
},
"title": "Info for a pinned item",
"type": "object"
},
"defs_room_id": {
"pattern": "^[R][A-Z0-9]{8}$",
"title": "Room ID for a slack call",
"type": "string"
},
"defs_team": {
"pattern": "^[T][A-Z0-9]{8}$",
"title": "Team ID",
"type": "string"
},
"defs_topic_purpose_creator": {
"pattern": "^[UW][A-Z0-9]{8}$|^$",
"title": "User ID or empty string, used for topic and purpose creation",
"type": "string"
},
"defs_ts": {
"pattern": "^\\d{10}\\.\\d{6}$",
"title": "Timestamp in format 0123456789.012345",
"type": "string"
},
"defs_user_id": {
"pattern": "^[UW][A-Z0-9]{8}$",
"title": "User ID",
"type": "string"
},
"objs_channel": {
"additionalProperties": true,
"properties": {
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"id": {
"$ref": "#/definitions/defs_channel_id"
},
"is_archived": {
"type": "boolean"
},
"is_channel": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"is_mpim": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_read_only": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"members": {
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"name_normalized": {
"type": "string"
},
"num_members": {
"type": "integer"
},
"pending_shared": {
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"previous_names": {
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"priority": {
"type": "integer"
},
"purpose": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"topic": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"unlinked": {
"title": "Field to determine whether a channel has ever been shared/disconnected in the past",
"type": "integer"
},
"unread_count": {
"type": "integer"
},
"unread_count_display": {
"type": "integer"
}
},
"required": [
"id",
"name",
"created",
"creator",
"is_channel",
"is_org_shared",
"is_private",
"is_mpim",
"is_shared",
"name_normalized",
"members",
"topic",
"purpose"
],
"title": "Channel Object",
"type": "object"
},
"objs_comment": {
"additionalProperties": true,
"properties": {
"comment": {
"type": "string"
},
"created": {
"type": "integer"
},
"id": {
"$ref": "#/definitions/defs_comment_id"
},
"is_intro": {
"type": "boolean"
},
"pinned_info": {
"$ref": "#/definitions/defs_pinned_info"
},
"pinned_to": {
"items": {
"$ref": "#/definitions/defs_channel"
},
"type": "array"
},
"reactions": {
"items": {
"$ref": "#/definitions/objs_reaction"
},
"type": "array"
},
"timestamp": {
"type": "integer"
},
"user": {
"type": "string"
}
},
"title": "File Comment Object",
"type": "object"
},
"objs_comments": {
"items": {},
"title": "file comments object",
"type": "array"
},
"objs_conversation": {
"items": [
{
"additionalProperties": true,
"properties": {
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"display_counts": {
"additionalProperties": true,
"properties": {
"display_counts": {
"type": "integer"
},
"guest_counts": {
"type": "integer"
}
},
"required": [
"display_counts",
"guest_counts"
],
"type": "object"
},
"has_pins": {
"type": "boolean"
},
"id": {
"$ref": "#/definitions/defs_channel"
},
"is_archived": {
"type": "boolean"
},
"is_channel": {
"type": "boolean"
},
"is_ext_shared": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_group": {
"type": "boolean"
},
"is_im": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"is_mpim": {
"enum": [
false
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_read_only": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"members": {
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"name_normalized": {
"type": "string"
},
"num_members": {
"type": "integer"
},
"pending_shared": {
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"pin_count": {
"type": "integer"
},
"previous_names": {
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"priority": {
"type": "integer"
},
"purpose": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"shared_team_ids": {
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"shares": {
"items": {
"additionalProperties": true,
"properties": {
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"team": {
"$ref": "#/definitions/objs_team"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"team",
"user",
"accepted_user",
"is_active"
],
"type": "object"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"topic": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"unlinked": {
"title": "Field to determine whether a channel has ever been shared/disconnected in the past",
"type": "integer"
},
"unread_count": {
"type": "integer"
},
"unread_count_display": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"title": "Conversation object",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"display_counts": {
"additionalProperties": true,
"properties": {
"display_counts": {
"type": "integer"
},
"guest_counts": {
"type": "integer"
}
},
"required": [
"display_counts",
"guest_counts"
],
"type": "object"
},
"id": {
"$ref": "#/definitions/defs_channel"
},
"is_archived": {
"type": "boolean"
},
"is_channel": {
"type": "boolean"
},
"is_ext_shared": {
"type": "boolean"
},
"is_general": {
"type": "boolean"
},
"is_group": {
"type": "boolean"
},
"is_im": {
"type": "boolean"
},
"is_member": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"is_mpim": {
"enum": [
true
],
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"is_private": {
"type": "boolean"
},
"is_read_only": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"members": {
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"name_normalized": {
"type": "string"
},
"num_members": {
"type": "integer"
},
"pending_shared": {
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"pin_count": {
"type": "string"
},
"previous_names": {
"items": {
"$ref": "#/definitions/defs_channel_name"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"priority": {
"type": "integer"
},
"purpose": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"shared_team_ids": {
"items": {
"$ref": "#/definitions/defs_team"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"shares": {
"items": {
"additionalProperties": true,
"properties": {
"accepted_user": {
"$ref": "#/definitions/defs_user_id"
},
"is_active": {
"type": "boolean"
},
"team": {
"$ref": "#/definitions/objs_team"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"team",
"user",
"accepted_user",
"is_active"
],
"type": "object"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"timezone_count": {
"type": "integer"
},
"topic": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"unlinked": {
"title": "Field to determine whether a channel has ever been shared/disconnected in the past",
"type": "integer"
},
"unread_count": {
"type": "integer"
},
"unread_count_display": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"id",
"name",
"created",
"creator",
"is_archived",
"is_channel",
"is_general",
"is_mpim",
"is_group",
"is_org_shared",
"is_im",
"is_shared",
"is_private",
"name_normalized",
"topic",
"purpose"
],
"title": "Conversation MPIM Object",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"created": {
"type": "integer"
},
"has_pins": {
"type": "boolean"
},
"id": {
"$ref": "#/definitions/defs_dm_id"
},
"is_ext_shared": {
"type": "boolean"
},
"is_im": {
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_shared": {
"type": "boolean"
},
"is_user_deleted": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"priority": {
"type": "integer"
},
"unread_count": {
"type": "integer"
},
"unread_count_display": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"id",
"created",
"is_im",
"is_org_shared",
"user",
"priority"
],
"title": "Conversation IM Channel Object from conversations.* methods",
"type": "object"
}
]
},
"objs_dnd": {
"additionalProperties": true,
"properties": {
"dnd_enabled": {
"type": "boolean"
},
"next_dnd_end_ts": {
"type": "integer"
},
"next_dnd_start_ts": {
"type": "integer"
},
"snooze_enabled": {
"type": "boolean"
}
},
"required": [
"dnd_enabled",
"next_dnd_end_ts",
"next_dnd_start_ts",
"snooze_enabled"
],
"type": "object"
},
"objs_file": {
"additionalProperties": true,
"properties": {
"channels": {
"items": {
"$ref": "#/definitions/defs_channel_id"
},
"type": "array",
"uniqueItems": true
},
"comments_count": {
"type": "integer"
},
"created": {
"type": "integer"
},
"display_as_bot": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"external_type": {
"type": "string"
},
"filetype": {
"type": "string"
},
"groups": {
"items": {
"$ref": "#/definitions/defs_group_id"
},
"type": "array",
"uniqueItems": true
},
"id": {
"$ref": "#/definitions/defs_file_id"
},
"image_exif_rotation": {
"type": "integer"
},
"ims": {
"items": {
"$ref": "#/definitions/defs_dm_id"
},
"type": "array",
"uniqueItems": true
},
"is_external": {
"type": "boolean"
},
"is_public": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"mode": {
"type": "string"
},
"name": {
"type": "string"
},
"original_h": {
"type": "integer"
},
"original_w": {
"type": "integer"
},
"permalink": {
"format": "uri",
"type": "string"
},
"permalink_public": {
"format": "uri",
"type": "string"
},
"pinned_info": {
"$ref": "#/definitions/defs_pinned_info"
},
"pinned_to": {
"items": {
"$ref": "#/definitions/defs_channel"
},
"type": "array"
},
"pretty_type": {
"type": "string"
},
"public_url_shared": {
"type": "boolean"
},
"reactions": {
"items": {
"$ref": "#/definitions/objs_reaction"
},
"type": "array"
},
"size": {
"type": "integer"
},
"thumb_1024": {
"format": "uri",
"type": "string"
},
"thumb_1024_h": {
"type": "integer"
},
"thumb_1024_w": {
"type": "integer"
},
"thumb_160": {
"format": "uri",
"type": "string"
},
"thumb_360": {
"format": "uri",
"type": "string"
},
"thumb_360_h": {
"type": "integer"
},
"thumb_360_w": {
"type": "integer"
},
"thumb_480": {
"format": "uri",
"type": "string"
},
"thumb_480_h": {
"type": "integer"
},
"thumb_480_w": {
"type": "integer"
},
"thumb_64": {
"format": "uri",
"type": "string"
},
"thumb_720": {
"format": "uri",
"type": "string"
},
"thumb_720_h": {
"type": "integer"
},
"thumb_720_w": {
"type": "integer"
},
"thumb_80": {
"format": "uri",
"type": "string"
},
"thumb_800": {
"format": "uri",
"type": "string"
},
"thumb_800_h": {
"type": "integer"
},
"thumb_800_w": {
"type": "integer"
},
"thumb_960": {
"format": "uri",
"type": "string"
},
"thumb_960_h": {
"type": "integer"
},
"thumb_960_w": {
"type": "integer"
},
"timestamp": {
"type": "integer"
},
"title": {
"type": "string"
},
"url_private": {
"format": "uri",
"type": "string"
},
"url_private_download": {
"format": "uri",
"type": "string"
},
"user": {
"type": "string"
},
"username": {
"type": "string"
}
},
"title": "file object",
"type": "object"
},
"objs_file_object_with_id_only": {
"$ref": "#/definitions/defs_file_id",
"additionalProperties": true,
"title": "file object with ID only",
"type": "string"
},
"objs_group": {
"additionalProperties": true,
"properties": {
"created": {
"type": "integer"
},
"creator": {
"$ref": "#/definitions/defs_user_id"
},
"id": {
"$ref": "#/definitions/defs_group_id"
},
"is_archived": {
"type": "boolean"
},
"is_group": {
"type": "boolean"
},
"is_moved": {
"type": "integer"
},
"is_mpim": {
"type": "boolean"
},
"is_open": {
"type": "boolean"
},
"is_pending_ext_shared": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"latest": {
"items": [
{
"$ref": "#/definitions/objs_message"
},
{
"type": "null"
}
]
},
"members": {
"items": {
"$ref": "#/definitions/defs_user_id"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
},
"name_normalized": {
"type": "string"
},
"priority": {
"type": "integer"
},
"purpose": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"topic": {
"additionalProperties": true,
"properties": {
"creator": {
"$ref": "#/definitions/defs_topic_purpose_creator"
},
"last_set": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"creator",
"last_set"
],
"type": "object"
},
"unread_count": {
"type": "integer"
},
"unread_count_display": {
"type": "integer"
}
},
"required": [
"id",
"name",
"is_group",
"created",
"creator",
"name_normalized",
"members",
"topic",
"purpose"
],
"title": "Group object",
"type": "object"
},
"objs_im": {
"additionalProperties": true,
"properties": {
"created": {
"type": "integer"
},
"id": {
"$ref": "#/definitions/defs_dm_id"
},
"is_im": {
"type": "boolean"
},
"is_org_shared": {
"type": "boolean"
},
"is_user_deleted": {
"type": "boolean"
},
"priority": {
"type": "integer"
},
"user": {
"$ref": "#/definitions/defs_user_id"
}
},
"required": [
"id",
"is_im",
"is_org_shared",
"user",
"created",
"is_user_deleted"
],
"title": "IM Object",
"type": "object"
},
"objs_inviting_user": {
"additionalProperties": true,
"properties": {
"id": {
"$ref": "#/definitions/defs_user_id"
},
"is_app_user": {
"type": "boolean"
},
"is_restricted": {
"type": "boolean"
},
"is_ultra_restricted": {
"type": "boolean"
},
"name": {
"type": "string"
},
"profile": {
"$ref": "#/definitions/objs_user_profile_shortest"
},
"real_name": {
"type": "string"
},
"team_id": {
"$ref": "#/definitions/defs_team"
},
"updated": {
"type": "number"
}
},
"required": [
"id",
"team_id",
"name",
"profile",
"is_restricted",
"is_ultra_restricted",
"updated",
"is_app_user"
],
"type": "object"
},
"objs_message": {
"additionalProperties": true,
"properties": {
"attachments": {
"items": {
"additionalProperties": true,
"properties": {
"fallback": {
"type": "string"
},
"id": {
"type": "integer"
},
"image_bytes": {
"type": "integer"
},
"image_height": {
"type": "integer"
},
"image_url": {
"type": "string"
},
"image_width": {
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"bot_id": {
"items": [
{
"$ref": "#/definitions/defs_bot_id"
},
{
"title": "Nil bot_id set when display_as_bot is false",
"type": "null"
}
]
},
"comment": {
"$ref": "#/definitions/objs_comment"
},
"display_as_bot": {
"type": "boolean"
},
"file": {
"$ref": "#/definitions/objs_file"
},
"icons": {
"additionalProperties": true,
"properties": {
"emoji": {
"type": "string"
}
},
"type": "object"
},
"inviter": {
"$ref": "#/definitions/defs_user_id"
},
"is_intro": {
"type": "boolean"
},
"last_read": {
"$ref": "#/definitions/defs_ts"
},
"name": {
"type": "string"
},
"old_name": {
"type": "string"
},
"permalink": {
"format": "uri",
"type": "string"
},
"pinned_to": {
"items": {
"$ref": "#/definitions/defs_channel"
},
"type": "array"
},
"purpose": {
"type": "string"
},
"reactions": {
"items": {
"$ref": "#/definitions/objs_reaction"
},
"type": "array"
},
"replies": {
"items": {
"additionalProperties": true,
"properties": {
"ts": {
"$ref": "#/definitions/defs_ts"
},
"u