5min

Overview



Regpack Open API is currently in beta testing and is slated for release in Q1 of 2022. We're excited to better partner with you and give organizations more flexibility to connect their business tools!



Below is an overview of the API's capabilities that highlights the key ideas of what the API can be used for. Additionally, you'll notice in the navigation bar to the left a section titled "Important Concepts" -- we included this to clarify some design concepts specific to Regpack itself which will help orient you as you navigate the API.

Capabilities

The Regpack Open API has three primary capabilities:

Calls

These calls form the bulk of the API and generally focus on the users. There are two endpoints: the users' endpoint and the status endpoint. The users' endpoint is used to create, update, and get information about your users while the status endpoint is used to create and edit statuses. See the navigation bar to the left for the list of calls which are available as well as examples of each call being used.

Webhooks

Webhooks allow for you to get push notifications from the system based on specific events when they happen. That information is sent to a URL which you specify. This is an alternative approach to standard the polling method where you periodically submit requests for updates. The webhooks can be configured in the webhooks tab of your project settings.

JavaScript Customization

Regpack loads on your website when you embed the iframe code and populates with the default properties. Although this will serve most needs, you are able to fine-tune this behavior further using JavaScript to control when the system populates and what project settings are active on this load instance. See the section on JavaScript customization for more on how to deploy this functionality as well as an illustrative example of its use.



Updated 25 Feb 2022
Did this page help?
Yes
No