API Documentation

SkySlope ¶

Overview ¶

SkySlope is a real estate transaction management software used by real estate agents and brokers. It helps users manage documents, streamline compliance workflows, and track transactions from start to finish

In order to do this, Rechat connects to a third party service called SkySlope.

We want to integrate Deal section with Skyslope to give our members ability to do this workflow in Skyslope and have all signed documents in Rechat deals.

Therefore, in order for Rechat to be able to do anything in this section, the user would have to authenticate with his Skyslope credentials.

Authentication ¶

The process of authenticating a user is as follows:

1. User’s browser will be opened to /brands/:brand/skyslope/auth

2. User’s browser will be redirected to skyslope

3. User logs in and authorizes Rechat

4. User’s browser will be redirected back to Rechat

5. Control is given back to client (either using Browser’s postMessage mechanism or redirecting him to rechat:// on phones)

6. Client tries again the initial action

{
  "code": "OK",
  "data": {
    "id": "74967300-0d7b-4843-a43a-2d6bbf8f86a7",
    "brand": "bb0c6752-516d-49c5-805b-76f3186da3ee",
    "created_at": "2026-08-27T00:56:32.374Z",
    "admin_credential": "c34215bf-a31d-427b-944e-498a3bd5efc0",
    "updated_at": "2026-08-27T00:56:32.374Z",
    "deleted_at": null,
    "skyslope_group": "e7fb0de4-3f9b-43be-a255-c043fcf6ffd8",
    "admin_id": "skyslopeId",
    "skyslope_group_id": "123456",
    "user": "084d046d-c6b7-4931-8f3a-398c0d391fd2",
    "skyslope_email": "[email protected]",
    "type": "skyslope_brand"
  }
}

{
  "code": "OK",
  "data": [
    {
      "id": 36095,
      "name": "Agreement Notice to Short Sale Addendum (Short Sale)",
      "libraryId": 14289,
      "attributes": {
        "form-type": "BRBC"
      },
      "source": "Amador County Local Documents - CA",
      "type": "skyslope_form"
    },
    {
      "id": 40144,
      "name": "BRBC Buyer Representation And Broker Compensation Agreement",
      "libraryId": 14289,
      "attributes": {
        "form-type": "BRBC"
      },
      "source": "Amador County Local Documents - CA",
      "type": "skyslope_form"
    }
  ],
  "info": {
    "count": 2,
    "total": 2
  }
}

{
          "code": "OK",
          "data": [
            {
              "id": 14289,
              "name": "Amador County Local Documents - CA",
              "regionCodes": [
                "US-CA"
              ]
            }
          ],
          "info": {
            "count": 1,
            "total": 1
          }
        }

if skyslope is not connected, this api return `428`

{
  "message": "SkySlope needs your permission before Rechat can access your forms and account details. You'll be redirected to SkySlope to review and approve the connection."
}

{
  "attachments": [
    {
      "task": "cee5ed02-48d3-418f-adb5-e1cc2c79ca95"
    }
  ],
  "auto_notify": true
}

{
  "code": "OK",
  "data": {
    "success": true,
    "envelope_id": "envelopeId",
    "type": "SKYSLOPE_ENVELOPE",
    "taskSyncErrors": {},
    "contactSyncErrors": {}
  }
}