🤖 Custom Fields API

What is an API?

It's not a beer! API, not IPA! An API is a set of definitions and protocols for building and integrating software. API stands for Application Programming Interface.

APIs let a product or service communicate with other products and services without having to know how they’re implemented.

For example, we use other APIs to pull in weather, send text messages, and similar 3rd party interactions. It allows you to build integrations between products.

What are Custom Fields in D4H?

Our Custom Fields feature allows you to add any data fields you want to a Member, Equipment Item, Incident Report, Incident Weather, Incident Person Involved, Team, Exercise Report, Event Report, Health & Safety Report, or a common field on all Activities. So for example, you might record 'Allergies' against a member, or a 'PO Number' against an item of equipment; you can customize D4H infinitely.

These fields can be different data types; Text (Single-line), Text Area (Multi-line), Date (Calendar), DateTime (Time Entry & Calendar), Single Choice (Dropdown), Multiple Choice (Multi-Select Dropdown), Numeric (Number), Time (Time Entry). For example, you could force a 'Risk Assessment Date' to be a Date & Time on a Training Exercise.

Custom Fields are grouped into headings called Custom Field Bundles. We take care of the creation and deletion of bundles, all you have to do is enter the title of the bundle you wish to use on the create or update of a field.

Ok great! What can I do with the Custom Fields API?

To get this level of customization, custom fields have to be a complex service. We built them before we had an API and we never added them to it afterward. This meant we could never include data from custom fields in our mobile apps, and customers building their own integrations could not get access to this data.

Since October we've been re-building the Custom Fields feature from the ground up, which is a shared-service across our products Personnel & Training, Equipment Management, and Incident Reporting. We're glad to say it's now fully available across our API at both Team and Organization levels.

  1. You can now access your custom fields data from a 3rd party application or script.
  2. You can now create, edit, and delete custom fields from a 3rd party application.
  3. We can now integrate custom field data into our mobile apps.

Release Notes (v9.21.0)

  • UI Improvements to Team > Settings > Custom Fields in the web app.

  • We've added the /v2/team/custom-fields API endpoint to teams.

    • GET /v2/team/custom-fields - List all Custom Fields.
    • POST v2/team/custom-fields - Create a Custom Field.
    • GET /v2/team/custom-fields/{id} - Get a Custom Field.
    • PUT /v2/team/custom-fields/{id} - Update a Custom Field.
    • DELETE /v2/team/custom-fields/{id} - Delete a Custom Field.
  • We've added the /v2/team/custom-fields/bundles endpoint.

    • GET /v2/team/custom-fields/bundles - List all Custom Field Bundles.
    • Custom Field Bundles are created and updated automatically as you create and update your Custom Fields.
  • We've added the /v2/team/custom-fields/{entity_type}/{entity_id} API endpoint to teams.

    • GET /v2/team/custom-fields/{entity_type}/{entity_id} - Get the Custom Fields and Custom Field Values for a specific entity.
    • PUT /v2/team/custom-fields/{entity_type}/{entity_id} - Set the Custom Field Value for a specific entity.

See our API Documentation for complete details.

We're looking forward to seeing what you create.