The Developer Pack (API and Webhook access) is only available on specific plans. Please check our pricing page for more details. It was previously offered as an add-on for the Professional plan and will remain active on existing subscriptions that already have it enabled. However, if it is canceled, you will need to upgrade to the Elite plan to regain access to the Developer Pack (API and Webhook access).
REST API
The Fulcrum JSON API uses REST endpoints for querying, creating, updating, and deleting data. The API provides users the ability to: query the URL for information using a GET request, to update the dataset by sending a PUT, or to delete the dataset by sending a DELETE. Each operation is a URL endpoint that represents either a single object or a collection of objects.
You can view the REST API introduction documentation here. Clicking on the API tab on the linked page will reveal a drop-down menu with additional pages on specific endpoints, changelogs, and field types.
Query API
The Query API provides read-only access to interact with your Fulcrum tables and data (records, repeatables, choice lists, members, media, etc.). This endpoint supports most standard PostgreSQL database functions, including many advanced spatial types supported by the PostGIS extension. The API enables real-time data analytics for integrating Fulcrum with a variety of Business Intelligence (BI) services and platforms, as well as permits more programmatic scripting for custom data exports.
You can view the Query API introduction documentation here. Clicking the Query tab on the linked page will reveal a drop-down menu with additional pages for references and examples.
Webhooks
Webhooks are a way to push notifications to your own servers, in real-time, as your data is created and modified, without the disadvantages of polling.
Hooking is a concept that’s been around in software for a while. One use of a hook is to extend the functionality of existing software. Webhooks are a way to extend the functionality of Fulcrum while using standard web technology.
The concept is straight-forward. When your data changes on the Fulcrum servers, we push a notification to your server to alert you. This allows you to write software to do something with that data.
More completely, changes to the data in your organization create events. Events contain information about that changed data. You register the URL of a server at which you’d like to be notified of these events. The events are then pushed to the webhook URL in an HTTP POST request. Your server receives and can then process the event and data.
You can view the Webhook developer page here. Additional help articles and guides for webhooks can be found here.
Professional Services
If you need assistance with getting the most out of the Developer Pack or would like us to build something that leverages the Developer Pack our professional services team can be leveraged.