RunReveal

SlackbotChannelList operation

GET
/slackbot/channel/list
curl -X GET "https://api.runreveal.com/slackbot/channel/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "channels": [
      {
        "id": "string",
        "isPrivate": true,
        "name": "string"
      }
    ]
  },
  "success": true
}

SlackbotConfigStatus operation

GET
/slackbot/config/status
curl -X GET "https://api.runreveal.com/slackbot/config/status"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "configured": true
  },
  "success": true
}

SlackbotConnectionDelete operation

POST
/slackbot/connection/delete

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/slackbot/connection/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

SlackbotConnectionList operation

GET
/slackbot/connection/list
curl -X GET "https://api.runreveal.com/slackbot/connection/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "connections": [
      {
        "botUserId": "string",
        "createdAt": {},
        "defaultChannelId": "string",
        "defaultChannelName": "string",
        "id": "string",
        "installedByUserId": "string",
        "role": "string",
        "slackTeamId": "string",
        "slackTeamName": "string",
        "updatedAt": {},
        "workspaceId": "string"
      }
    ]
  },
  "success": true
}

SlackbotConnectionUpdate operation

POST
/slackbot/connection/update

Request Body

application/jsonRequired

idstring

rolestring

curl -X POST "https://api.runreveal.com/slackbot/connection/update" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "role": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "botUserId": "string",
    "createdAt": {},
    "defaultChannelId": "string",
    "defaultChannelName": "string",
    "id": "string",
    "installedByUserId": "string",
    "role": "string",
    "slackTeamId": "string",
    "slackTeamName": "string",
    "updatedAt": {},
    "workspaceId": "string"
  },
  "success": true
}

SlackbotInstall operation

GET
/slackbot/install

Query Parameters

rolestring

workspaceIdstring

curl -X GET "https://api.runreveal.com/slackbot/install?role=string&workspaceId=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "redirectUrl": "string"
  },
  "success": true
}

POST
/slackbot/user/link

Request Body

application/jsonRequired

statestring

curl -X POST "https://api.runreveal.com/slackbot/user/link" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

SlackbotUserLinkDelete operation

POST
/slackbot/user/link/delete

Request Body

application/jsonRequired

idstring

slackUserIdstring

curl -X POST "https://api.runreveal.com/slackbot/user/link/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "slackUserId": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

GET
/slackbot/user/link/list
curl -X GET "https://api.runreveal.com/slackbot/user/link/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "links": [
      {
        "SlackUserLink": {
          "id": "string",
          "linkedAt": {},
          "runrevealUserId": "string",
          "runrevealWorkspaceId": "string",
          "slackTeamId": "string",
          "slackUserId": "string",
          "updatedAt": {}
        },
        "runrevealUserEmail": "string"
      }
    ]
  },
  "success": true
}

SlackbotUserLinkStatus operation

GET
/slackbot/user/link/status
curl -X GET "https://api.runreveal.com/slackbot/user/link/status"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "configured": true,
    "connected": true,
    "link": {
      "id": "string",
      "linkedAt": {},
      "runrevealUserId": "string",
      "runrevealWorkspaceId": "string",
      "slackTeamId": "string",
      "slackUserId": "string",
      "updatedAt": {}
    },
    "linked": true,
    "slackTeamName": "string"
  },
  "success": true
}