API and Developer Documentation

Learn about single sign on, available integrations, and the OpenWater API.

22 articles in this collection
Written by Kunal Johar and Zack Schwartz

Handlebars Templates

Use logic, loops and conditions when creating template (email confirmation, PDFs, galleries)

Written by Kunal Johar
Updated over a week ago

Single Sign On

Magic Link External Source

Written by Kunal Johar
Updated over a week ago

What is single single sign on (SSO)?

Single sign on allows your users to login to OpenWater with the same credentials they use to login to your own website

Written by Zack Schwartz
Updated over a week ago

Enable single sign on (SSO)

Allow users to login with the same credentials they use on your own website

Written by Zack Schwartz
Updated over a week ago

Build a single sign on (SSO) to OpenWater

Have your developers build their own single sign on (SSO) with OpenWater using the Json Web Token (jwt) standard

Written by Zack Schwartz
Updated over a week ago

API

Web Hooks

Receive small JSON events based on activity in OpenWater

Written by Kunal Johar
Updated over a week ago

OpenWater REST API

Learn how to access our REST api

Written by Kunal Johar
Updated over a week ago

OpenWater Javascript (JS) API

Documentation for our frontend api to manipulate the application, review and session chair forms.

Written by Kunal Johar
Updated over a week ago

Pre-Fill Fields on an Application

Set fields on an application when a user begins a new submission

Written by Kunal Johar
Updated over a week ago

Auto-Complete and Pre-Fill Fields

Allow submitters to key a few strokes and show an auto-complete list of options.

Written by Kunal Johar
Updated over a week ago

Advanced Developer Topics

OpenWater Cookie Policy

What Cookies does OpenWater use

Written by Kunal Johar
Updated over a week ago

Capacity Limits

Documentation of default media storage, database storage, api speed, and applications count

Written by Kunal Johar
Updated over a week ago

View log of successful and failed single sign on (SSO) attempts

Monitor your SSO login attempts to see if you are having integration issues.

Written by Zack Schwartz
Updated over a week ago

Add Google Analytics to your portal

Track visitors and integrate google analytics functionality

Written by Zack Schwartz
Updated over a week ago

Setup a custom domain

Use a dedicated domain like www.yourawardshere.com. Also known as a vanity domain or a CNAME.

Written by Zack Schwartz
Updated over a week ago

PDF Engine Flags

The PDF as applicant/judge can be modified to print in landscape, show page numbers, or have a custom header/footer.

Written by Kunal Johar
Updated over a week ago

Highly customized reports with Python

Advanced Reporting Engine: Json Export

Generate a JSON file, or prepare a report for a programmatic API call.

Written by Zack Schwartz
Updated over a week ago

Advanced Reporting Engine: TXT Export

Generate a completely customized TXT output from a report

Written by Zack Schwartz
Updated over a week ago

Advanced Reporting Engine: PDF / HTML Export

For advanced usage, design your own PDF / HTML output in reports

Written by Zack Schwartz
Updated over a week ago

Legacy API (Supported until December 31, 2022)

Introduction to the OpenWater Data API

Pull data out of OpenWater programmatically

Written by Zack Schwartz
Updated over a week ago

OpenWater API: Report Endpoint

Learn how to pull submission and judge data out of OpenWater via the API

Written by Zack Schwartz
Updated over a week ago

OpenWater API: Invoices / Payments Endpoint

Pull finance data out of OpenWater with our API

Written by Zack Schwartz
Updated over a week ago