No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
documentation
README.md

README.md

Get started

Welcome to the ActivityHub Platform! Below is a quick introduction of how to connect to and use the API.

1. Obtain credentials

In order to use ActivityHub as a developer, you'll need to obtain a keyset for your application.

2. Make your first API call

As an example API call, try hitting the get_available_acct_types endpoint. You'll need to use the following information for all requests made to our servers:

URL: https://api.activityhub.io/parse/functions/<FUNCTION>

HTTP verb: POST

Unless otherwise specified, all ActivityHub API calls should be POST requests.

Headers:

X-Parse-Application-Id: "ACTIVITYHUB-PLATFORM-API"

Content-Type: "application/json"

3. Make authenticated API calls

Now that you know how to make an API call to ActivityHub, the next step is to authenticate a user and start making real requests! You've already completed the first few steps, and the authentication documentation is a great place to go from here.


Table of contents

Endpoints are grouped into the following categories:

  1. Authentication
    • Provides an explanation for how to authenticate your app and your users with the ActivityHub service
  2. User management
    • Explains things like getting a user's profile, updating their account information, and handling licenses
  3. Event management
    • Provides details on getting, creating, updating, responding to, and deleting events via ActivityHub
  4. Task management
    • Provides details on getting, creating, updating, and deleting tasks in Salesforce via ActivityHub
  5. Contact management
    • ActivityHub supports fetching a user's contacts from any of their accounts they've added to our system, as well as creating new ones
  6. Salesforce integration
    • Documentation on using Salesforce-specific ActivityHub functionality
  7. GoToMeeting integration
    • Creating GoToMeeting data, as well as detecting it in an event
  8. Phones and SMS
    • ActivityHub has some pretty neat capabilities via SMS, documented here
  9. Bots!
    • Information on how to utilize our growing bot functionality
  10. Surveys
    • Getting and responding to surveys
  11. Utilities
    • Various helper functions pertaining to general data and location services.
  12. Developer console
    • Endpoints used to run our developer console
  13. Event state machine & task syncing
    • Details on how ActivityHub syncs events and tasks between all users' calendars, our database, and Salesforce
  14. Data tables
    • Brief summaries of each table in our database

Response error handling

Overview

When ActivityHub returns an error, the format will always include the following information:

  • StatusCode - number indicating the type of error (possible values listed below)
  • InternalError - boolean, true if this was an error within ActivityHub. An example an a non-internal error would be Google returning a failure message that ActivityHub can't auto-resolve
  • ErrorDesc - string providing basic information on the problem
  • ErrorDetails - string providing more technical information or debug details on the error. This value may be null

Error codes

  • 400 - Malformed request to ActivityHub
  • 401 - Invalid ActivityHub access token
  • 403 - Unauthorized to access this endpoint within ActivityHub
  • 404 - Resource not found (this can include failing to find data due to insufficient permissions)
  • 500 - General internal error
  • 502 - General external error (i.e., an error response from Google)

Example error response

{
  "StatusCode": 500,
  "InternalError": true,
  "ErrorDesc": "An internal error has occurred.",
  "ErrorDetails": "If non-null, this will contain technical details."
}