connector.json

{
  "name": "Highrise",
  "slug": "highrise",
  "url": "http://www.highrisehq.com",
  "auth_types": {
    "Private": {
      "setup_help": "./samples/setupHelp.md",
      "requires_signing": false,
      "features": [
        "One Highrise Account",
        "Domain and API copied from Highrise",
        "No auth steps"
      ]
    },
    "Public": {
      "setup_help": "./samples/setupHelpPublic.md",
      "requires_signing": true,
      "features": [
        "Mangage multiple Highrise accounts",
        "Hoist handles the OAuth"
      ]
    }
  },
  "settings": [{
    "key": "apiToken",
    "type": "text",
    "description": "API Token",
    "for_types": ["Private"],
    "required": true
  }, {
    "key": "domain",
    "type": "text",
    "description": "Domain",
    "for_types": ["Private"],
    "required": true
  }, {
    "key": "clientId",
    "type": "text",
    "description": "Client ID",
    "for_types": ["Public"],
    "required": true
  }, {
    "key": "clientSecret",
    "type": "text",
    "description": "Client Secret",
    "for_types": ["Public"],
    "required": true
  }],
  "samples": {
    "gettingStarted": "./samples/gettingStarted.js"
  },
  "endpoints": {
    "people": {
      "sample": "./samples/gettingStarted.js",
      "docs": "https://github.com/basecamp/highrise-api/blob/master/sections/people.md",
      "subscribe": true,
      "events": ["new", "modified"]
    },
    "companies": {
      "sample": "./samples/gettingStarted.js",
      "docs": "https://github.com/basecamp/highrise-api/blob/master/sections/companies.md",
      "subscribe": true,
      "events": ["new", "modified"]
    }
  }
}