Using the Engage Outbound API

• The currently documented endpoints provide read-only access using GET requests.
• API access requires an authorised Bearer Token.
• Access is not automatic. Contact Engage Support to discuss the intended use and available data.
• A Bearer Token is a credential and must be stored securely.

• Documentation: api-docs.engagesolutions.app
• Production server: https://api.engagesolutions.app/api
• Request method: GET
• Authentication: Bearer Token
• Rate limit: 100 calls per 60 seconds
• Access and support: support@engagesolutions.co.nz

The API documentation currently includes endpoints for selected information relating to:

• Employees
• Incidents
• Companies
• Branches
• Departments
• Cost centres
• Delivery centres

Incident endpoints may also provide related information such as people involved, affected areas, linked risks and witnesses, depending on the endpoint used.

Refer to the live API documentation for the current endpoints, request parameters and response fields. Not every Engage module or data field is available through the outbound API.

1. Contact Engage Support and provide your organisation name, intended business use, systems involved and the information you need to retrieve.
2. Engage will confirm whether the available API is suitable and discuss the appropriate scope and access arrangements.
3. Once approved, the Bearer Token will be provided through an appropriate secure process.
4. Your developer or integration provider can then use the live documentation to configure and test the connection.

API access should be requested only for a defined and authorised business purpose.

1. Open the Engage API documentation portal.
2. Locate the relevant endpoint and review its parameters and response information.
3. Use the Authorize function to enter the Bearer Token only within a secure, private session.
4. Test the required GET request and confirm that the returned data meets the approved use.
5. Configure the integration to remain within the published rate limit.

• Never publish a Bearer Token in a knowledge base article, screenshot, public code repository or client-side application.
• Do not include the token in the description of a support ticket or ordinary email.
• Limit access to the people and systems that require it.
• Contact Engage Support promptly if a token may have been exposed or is no longer required.
• Handle all information retrieved from Engage in accordance with your organisation's privacy, security and record-management obligations.

Can the API be used to change information in Engage?
The currently documented endpoints use GET requests and provide read-only access.

Is every Engage module and field available?
No. Only the endpoints and data described in the live API documentation are currently available.

Where can I find the exact technical specification?
Use the Engage API documentation portal. It remains the source of truth for the current endpoints and fields.

How do I obtain access?
Contact Engage Support with the intended use and information requirements. Access arrangements can then be confirmed.

What happens if the rate limit is exceeded?
Review how frequently the integration is making requests and reduce unnecessary calls. Contact Engage Support if further assistance is required.