Take a free self-guided product tour to see our solutions in action Take a tour

Welcome to Notify’s API developer portal

Our mission is to empower your organisations to interact and integrate with Notify, so that you can get the most out of your Safety, Health, Environmental and Quality data. You’ll find documentation to help you to start authenticating and then integrating with Notify Cloud.

API Documentation
developer

Notify – Public API – Developer Portal

Getting started

Our Public API currently supports the ability to request Incident, Audit and Action data from Notify Cloud and will be provided in a structured JSON file format.

Over the coming months we will be expanding our API’s capabilities, so please check back soon.

Any company that currently has an active Notify Cloud contract can leverage our API.

You will need to request an API key via a Service Desk - Get Help ticket. We will then be in-touch to explore your requirements.

Once you have been provided with a Public API Key, this will need to be included in the Header request which will check the key belongs to an active company. It will also check that the key is valid and enabled and you are authorised to have access to Incidents, Audit and Action data.

Notify do not currently provide a testing or sandbox environment for our Public API.

  1. Daily Quota – The client shall not exceed 2500 API calls per day.
  2. Rate Limit – The client shall not exceed 200 API calls every 60 seconds.
  3. Data and Timestamps - all dates and times such as Incident Reported, Action Created, Audit Completed are in Universal Time Convention (UTC).
  4. Multi-Language – we currently do not support true multi-language where you pass a locale and we return data in that language. Incident Capture, Investigation and Audit data will be returned based on the default language of the relevant default supported language specified in the relevant form templates.

Technical Specification

Notify Cloud Public API provides authorised users the ability to interact with their Notify data.

Access to the API requires an additional module licence. For existing customers who are interested, please speak to your Notify Customer Success Representative.

Note: we currently do not provide a Trial access to our Public APIs.

The following end points and common use cases can be supported:

Incidents End Point

  • GET – Incident Statistics – for example, returning a simple volume of incident counts, lost time or reportable incidents over a requested date range.

  • GET – Incident Capture and Investigation RAW Data – for example, returning the full structured and unstructured Incident Capture and Investigation data over a requested date range.

Audits End Point

  • GET – Audits Summary Data – for example, returning a simple volume of audit counts, by status, RAG Grade or Score over a requested date range.

  • GET – Audit Detailed Content Data – for example, returning the full structured and unstructured Audit sections, questions, and response data over a requested date range.

Actions End Point

  • GET – Action Summary Data – for example, returning a simple volume of actions, by status and priority, over a requested date range.

  • GET – Action Detailed Content Data – for example, returning the full detailed content structured, and unstructured Action data over a requested date range.

Risk Assessments Endpoints

  • GET – Risk Assessment Summary Data – for example, returning a simple volume of Risk Assessments, by status and priority, over a requested date range.

  • GET – Risk Assessment Detailed Content Data – for example, returning the full detailed content structured, and unstructured Risk Assessment data over a requested date range.

Method Statement Endpoints

  • GET – Risk Assessment Summary Data - for example, returning a simple volume of Risk Assessments, by status and priority, over a requested date range.

  • GET – Method Statement Detailed Content Data – for example, returning the full detailed content structured, and unstructured Risk Assessment data over a requested date range.

Organisation Structure Endpoint

  • GET – Organisation Structure Data - for example, returning the detailed structure, on a level-by-level basis.

User Management Endpoint

  • GET – User Summary Data - for example, returning the user data by username, module and status.

View more detailed information via our Swagger documentation

All support for our Public API is managed via our Service Desk.

Notify is responsible for setting up and configuring the API Integration with the client's authorized representative and will provide the API key via a secure communication channel.

Security Requirements and Technical Standards

Our Public API is designed to be performant, scalable and with a consistency of data structure that follows industry best practice.

Our API is built using the RESTful principles using HTTP verb requests to manipulate data.

All data is returned in a structured JSON file format. JSON object keys are formatted using camelCase. Dates are formatted in ISO 8061 format. Data will be returned encoded in Unicode Transformation Format (UTF-8) standard.

Note: For further information relating to endpoints and data structure format, please refer to our Swagger documentation

Requests to our API must be made using a secure HTTPS connection and must include a valid API Key. The latest secure and supported Transport Layer Security (TLS) must be used when communicating with the API.

Important: Secure Sockets Layer (SSL) or TLS v1.0 must not be used.

Each API end point includes a version number to help ensure backwards compatibility when changes are made in the future.

Versioning guarantees that existing functionality continues to be supported, whilst providing the increased flexibility for customers to use new features and data points, as and when they are available.

Should we decide to deprecate an old version of an end point, we will give reasonable notice whilst also ensuring that all API documentation is kept up to date.

Notify Cloud Public API aligns its service availability, support, and maintenance as described in our overarching Schedule 1 – SLA of the Notify Master Services Agreement