API docs by Redocly

Safe Food Pro (1.0.0)

Download OpenAPI specification:

E-mail: support@safefoodpro.co.nz License: Apache 2.0 Terms of Service

This is the API to interact with Safe Food Pro.

  • You can find out more about Safe Food Pro at https://www.safefoodpro.co.nz.
  • API calls are authenticated with Firebase uid and Firebase token header parameters.
  • Dates and times are always in epoch milliseconds.

Rate Limiting

To ensure stability and fair usage, this API enforces rate limiting based on a token bucket algorithm.

Limits are governed by two factors: a steady-state request rate (requests per second) and a maximum burst capacity. If you sustain a traffic volume higher than the allowed rate, or if you send a sudden spike of traffic that exceeds the burst capacity, the API will reject the excess requests and respond with an HTTP 429 Too Many Requests status code.

We strongly encourage all clients and automated integrations to implement exponential backoff with jitter when handling 429 responses. Attempting to immediately retry failed requests without a delay queue will result in sustained rejections and degraded performance.

SafeFoodPro

API to interact with Safe Food Pro

Find out more

newStaff

A new Staff record has been created in your Safe Food Pro Organisation. Webhook

Informs webhook listener (i.e. subscription target URL) that a new Staff record has been created.

header Parameters
X-Hook-Signature
required
string

The HMAC-SHA1 signature of the raw request body, generated using the system-provided X-Hook-Secret as the cryptographic key, and formatted as a hexadecimal digest.

Request Body schema: application/json
payload
required
string

A new Staff record or a completed Form instance

required
object (WebSubscriptionHook)

Responses

Request samples

Content type
application/json
{
  • "payload": "A new Staff record or a completed Form instance",
  • "hook": {
    }
}

completedFormInstance

An instance of a Form has been completed in your Safe Food Pro Organisation. Webhook

Informs listener (i.e. subscription target url) that a Form Instance has been completed.

header Parameters
X-Hook-Signature
required
string

The HMAC-SHA1 signature of the raw request body, generated using the system-provided X-Hook-Secret as the cryptographic key, and formatted as a hexadecimal digest.

Request Body schema: application/json
payload
required
string

A new Staff record or a completed Form instance

required
object (WebSubscriptionHook)

Responses

Request samples

Content type
application/json
{
  • "payload": "A new Staff record or a completed Form instance",
  • "hook": {
    }
}

formInstances

Retrieve a list of Form Instances.

Returns an array of completed and incomplete form instances for the authenticated organisation.

Authorizations:
(firebaseTokenfirebaseUserId)
query Parameters
from
integer <int64>
Example: from=1770083945000

Filter forms submitted from this date (in epoch milliseconds).

to
integer <int64>
Example: to=1770152764000

Filter forms submitted up to this date (in epoch milliseconds).

category
string
Example: category=Others

Filter by form category.

name
string
Example: name=Example Form

Filter by exact form name.

header Parameters
x-organisation-id
required
string

Specifies the target Organisation ID for the request context.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

users

Add a new User to your Safe Food Pro Organisation.

Create a new user in your organisation.

Authorizations:
(firebaseTokenfirebaseUserId)
header Parameters
x-organisation-id
required
string

Specifies the target Organisation ID for the request context.

Request Body schema: application/json
required

User to be added to your Organisation

firstName
required
string
lastName
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "firstName": "First name",
  • "lastName": "Surname",
  • "email": "admin@example.com"
}

Response samples

Content type
application/json
{
  • "firstName": "First name",
  • "lastName": "Surname",
  • "email": "admin@example.com",
  • "roleName": "Tablet",
  • "externalId": "ExtId",
  • "organisationId": 1234,
  • "organisationName": "Org Name",
  • "organisationGroupName": "Org Group Name",
  • "whenCreated": 0
}

subscriptions

Create a Webhook subscription.

Registers a new webhook subscription. The user and organisation IDs are dynamically derived from your authentication token.

Authorizations:
(firebaseTokenfirebaseUserId)
Request Body schema: application/json
required

Webhook REST subscription.

event
required
string
targetUrl
required
string
userEmail
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Create or update a Webhook subscription by ID.

Updates an existing webhook subscription. The user and organisation IDs are dynamically derived from your authentication token.

Authorizations:
(firebaseTokenfirebaseUserId)
path Parameters
id
required
integer <int32>

ID of the webhook subscription.

Request Body schema: application/json
required

Webhook REST subscription.

event
required
string
targetUrl
required
string
userEmail
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}