Cloud Functions SDK

Reference material for the FunctionContext, the resources it exposes, and the API client.

This section contains documentation about the IXON Cloud Function SDK tools, which you will need to develop custom Cloud Functions. Each page focuses on one part of the FunctionContext — the object passed as the first argument to every exposed function — and the clients it provides.

Use the Cloud Functions SDK section when you're writing code and want to look up exactly what's available, what each method does, and how to call it. For conceptual context, check the links in Cloud Functions Basics. For a step-by-step tutorial, see How to create a Cloud Function.

In this section

  • Context API — An overview of the FunctionContext fields with focused snippets for reading resources, accessing configuration, calling the API, and using the Document Store.
  • Resources — The user, company, agent, asset, and agent_or_asset properties on the context: which fields each has, when each is available, and how to read custom properties and permissions.
  • Using the API client — Calling the IXON API from your Cloud Function: HTTP methods, listing and pagination, error handling, access scopes, and custom API Applications.