Cloud Elements Open Labs Overview and Guidelines

Cloud Elements Open Labs is a GitHub repository where Cloud Elements users can share elements they have created with the larger user community. Community members can download elements from the repository and further enhance or customize them for their own needs, and share their newly revised elements back to the community for others to further work with or develop.

Disclaimers and Notes

  • Cloud Elements provides this repository with the understanding that Cloud Elements does not maintain the integrity of the code for the elements herein. If endpoints change, these elements and changes are not necessarily known, monitored, or supported by Cloud Elements.

  • Cloud Elements also does not guarantee the stability or usability of these elements.

  • Community members should not add anything to this repository they do not want to be publicly shared.

  • By contributing any code or content to Cloud Elements Open Labs, you accept and agree to the terms outlined in the Cloud Elements Contributor License Agreement. When using Cloud Elements templates or code, you accept and agree to the terms of the MIT license as stated in GitHub.

Security

For your own security, ensure that you remove any API keys, API secrets, or hard-coded personal data prior to uploading any elements or code. In the event you accidentally leave these included in the element, your pull request will be rejected. 

Keep in mind that, even if you remove previously included personal data on a later commit, it would be stored forever in Git, leaving your information vulnerable unless you hard-delete the sensitive commit.

Contributing Elements to the Repository

In order to contribute to the Cloud Elements Open Labs repository, follow these instructions and see inline links for additional details:

  1. Fork and clone the repository.
  2. Create a new branch.
  3. Add or updated the code you are contributing.

    Note: If you are contributing a new element, first review the basic standards for elements. In addition, because Github's folder names are case-sensitive, capitalize the first letter of your new folder in Github.

  4. Push your branch back to the repository and make a pull request.
  5. In addition to the file containing the element JSON, please also include:

    • A short README.md file including a description of your contribution, the endpoint name, and resources available
    • A link to the documentation you used to create the element or code
    • Any known endpoint limitations or nuances that may affect your element's functionality

Using Elements from the Repository

  1. Either clone the repository or grab the JSON using the Raw tab for the element you want to use.
  2. In the Cloud Elements platform, navigate to the Elements page and click Build a new element.
  3. Click Import.
  4. Navigate to the cloned folder and to the element's JSON file.

For more information about importing elements, see Import and Export Elements.

Basic Element Standards

In order to maintain consistent expectations and proper functionality across the Cloud Elements platform, we've established these standards for contributed elements. If your element does not yet meet these standards, please contact implementation@cloud-elements.com for assistance in getting your element up to the necessary standard for Open Labs contribution.

Required

  • Working authentication
  • At least one working resource

Suggested

  • Events
  • Querying via the where parameter
  • Paging via page, pagesize query parameters
  • Bulk
  • Refresh authorization
  • Commented JavaScript when required for hook(s)

For additional information about building or enhancing elements, see our Element Builder documentation.