Skip to content
Mitchell Currey edited this page Jul 18, 2022 · 4 revisions

Forbury

Forbury Integrations Wiki

This is the official documentation for the usage of the Forbury API and Integrations project library.

Note: In order to use this library, you must be an existing Forbury customer and have an API ClientId and ClientSecret, this can be provided by the Forbury Development Team. Please see the contact us section below to reach out.

To learn more about becoming a Forbury customer, please contact sales.

Contents

  • Quick Start Guide - Get started with setup of the Integrations project and example usage.
  • Webhooks - How to get setup with the various options and events our webhook infrastructure provides.
  • Custom Fields - See how Custom Fields work with your Custom Sheets inside a Forbury Model for truly powerful API tooling.
  • Exception Handling - Details on the exception handling and error messaging within the Forbury API, including recommend handling examples.
  • Model-API Relationship - See what API DTO fields relate to what sections of the Forbury Models.

Swagger Documentation

In addition to this Wiki, full Swagger API documentation can be found here.

Security

We take security very seriously at Forbury. If you have noticed any security concerns with this library or the API itself, please see the contact us section below to discreetly send an email to the Forbury Development Team.

We ask you to please not raise an issue on this GitHub directly for security concerns or vulnerabilities you may find.

Contact us

For additional information regarding this project library, or in order to get access, please email the Forbury Development Team at developers@forbury.com.

Clone this wiki locally