AgriWebb API

Introduction

Where to start with the AgriWebb API, with an API key or as a Marketplace partner, and what its GraphQL and Reports APIs are for.

Illustration of laptop with AgriWebb software and farmers on either side

If AgriWebb has issued you an API key, you don't need to register or implement the OAuth 2.0 flow. See Authentication for how to send the key, then go to the GraphQL API or the Reports API.

Marketplace partners start with Partner Registration, then follow the Integration Guide.

Architecture

The AgriWebb API has two parts: a GraphQL API to query and mutate farm data, and a REST Reports API to generate reports as CSV. Both are called over HTTPS with one of two credentials: an access token, which Marketplace partners get from the OAuth 2.0 authorisation server once a user grants permission, or an API key issued by AgriWebb.

API changes

We keep adding endpoints, queries and mutations to the API, and optional fields to existing objects. Breaking changes are only made in a new major version.

We have a Slack community group. Join that group to stay up to date with changes to the API and ask any API related questions. Talk to your contact at AgriWebb to get added.

On this page