Install Private Apps

Print
Dark
Light
PDF

Install Private Apps

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/apps

Install a private app via URL. Permission required: manage-apps

Changelog

Version	Description
3.1.0	Added

Header parameters

X-Auth-Token

stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters

You can use either the app or url parameter to upload the file.

Example

{
  "url": "https://github.com/RocketChat/Apps.RocketChat.Tester/blob/master/dist/appsrocketchattester_0.0.5.zip?raw=true",
  "app": "cGF0aCB0byB0aGUgemlwIGZpbGU="
}

Expand All

object

url

string

The app URL where the zip file is located.

app

string (binary)

The zip file containing the app.

permissions

Array of object

An array of the permissions required for your app. This is required if permissions are defined in your app.json file.

object

name

string

Responses

200

Success

{
  "app": {
    "id": "bc4dd4a1-bf9b-408e-83a4-aba7eba0bf02",
    "version": "0.0.5",
    "requiredApiVersion": "^1.33.0",
    "iconFile": "icon.png",
    "author": {
      "name": "Rocket.Chat",
      "homepage": "https://github.com/RocketChat",
      "support": "a"
    },
    "name": "Apps.RocketChat.Tester",
    "nameSlug": "appsrocketchattester",
    "classFile": "AppsRocketChatTesterApp.js",
    "description": "An app that provides endpoints to test Apps integration to Rocket.Chat",
    "implements": [],
    "iconFileContent": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQBAMAAACAGwOrAAAAG1BMVEUAAAD///9fX19/f38/Pz+fn5/f398fHx+/v7F+DAse5zMkkE4D1Jf6exKnYRje4LriXRQ0JzTVP2t7hLNtFWODfxNqiaa6VE8tGjFCxXyc1HHsTisiQ0rijg4mTvyAAAElFTkSuQmCC",
    "status": "auto_enabled"
  },
  "implemented": {
    "IPreMessageSentPrevent": false,
    "IPreMessageSentExtend": false,
    "IPreMessageSentModify": false,
    "IPostMessageSent": false,
    "IPreMessageDeletePrevent": false,
    "IPostMessageDeleted": false,
    "IPreMessageUpdatedPrevent": false,
    "IPreMessageUpdatedExtend": false,
    "IPreMessageUpdatedModify": false,
    "IPostMessageUpdated": false,
    "IPostMessageReacted": false,
    "IPostMessageFollowed": false,
    "IPostMessagePinned": false,
    "IPostMessageStarred": false,
    "IPostMessageReported": false,
    "IPreRoomCreatePrevent": false,
    "IPreRoomCreateExtend": false,
    "IPreRoomCreateModify": false,
    "IPostRoomCreate": false,
    "IPreRoomDeletePrevent": false,
    "IPostRoomDeleted": false,
    "IPreRoomUserJoined": false,
    "IPostRoomUserJoined": false,
    "IPreRoomUserLeave": false,
    "IPostRoomUserLeave": false,
    "IPostExternalComponentOpened": false,
    "IPostExternalComponentClosed": false,
    "IUIKitInteractionHandler": false,
    "IUIKitLivechatInteractionHandler": false,
    "IPostLivechatRoomStarted": false,
    "IPostLivechatRoomClosed": false,
    "ILivechatRoomClosedHandler": false,
    "IPostLivechatAgentAssigned": false,
    "IPostLivechatAgentUnassigned": false,
    "IPostLivechatRoomTransferred": false,
    "IPostLivechatGuestSaved": false,
    "IPostLivechatRoomSaved": false,
    "IPreFileUpload": false,
    "IPreEmailSent": false,
    "IPostUserCreated": false,
    "IPostUserUpdated": false,
    "IPostUserDeleted": false,
    "IPostUserLoggedIn": false,
    "IPostUserLoggedOut": false,
    "IPostUserStatusChanged": false
  },
  "licenseValidation": {
    "errors": {},
    "warnings": {}
  },
  "success": true
}

Expand All

object

app

object

string

version

string

requiredApiVersion

string

iconFile

string

author

object

name

string

homepage

string

support

string

name

string

nameSlug

string

classFile

string

description

string

implements

Array of object

object

iconFileContent

string

status

string

implemented

object

IPreMessageSentPrevent

boolean

IPreMessageSentExtend

boolean

IPreMessageSentModify

boolean

IPostMessageSent

boolean

IPreMessageDeletePrevent

boolean

IPostMessageDeleted

boolean

IPreMessageUpdatedPrevent

boolean

IPreMessageUpdatedExtend

boolean

IPreMessageUpdatedModify

boolean

IPostMessageUpdated

boolean

IPostMessageReacted

boolean

IPostMessageFollowed

boolean

IPostMessagePinned

boolean

IPostMessageStarred

boolean

IPostMessageReported

boolean

IPreRoomCreatePrevent

boolean

IPreRoomCreateExtend

boolean

IPreRoomCreateModify

boolean

IPostRoomCreate

boolean

IPreRoomDeletePrevent

boolean

IPostRoomDeleted

boolean

IPreRoomUserJoined

boolean

IPostRoomUserJoined

boolean

IPreRoomUserLeave

boolean

IPostRoomUserLeave

boolean

IPostExternalComponentOpened

boolean

IPostExternalComponentClosed

boolean

IUIKitInteractionHandler

boolean

IUIKitLivechatInteractionHandler

boolean

IPostLivechatRoomStarted

boolean

IPostLivechatRoomClosed

boolean

ILivechatRoomClosedHandler

boolean

IPostLivechatAgentAssigned

boolean

IPostLivechatAgentUnassigned

boolean

IPostLivechatRoomTransferred

boolean

IPostLivechatGuestSaved

boolean

IPostLivechatRoomSaved

boolean

IPreFileUpload

boolean

IPreEmailSent

boolean

IPostUserCreated

boolean

IPostUserUpdated

boolean

IPostUserDeleted

boolean

IPostUserLoggedIn

boolean

IPostUserLoggedOut

boolean

IPostUserStatusChanged

boolean

licenseValidation

object

errors

object

warnings

object

success

boolean

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?

What's Next

Close Chat or Perform Handover