Robaws API

We distinguish two types of integrations: a custom integration and a marketplace integration.

• A custom integration is built for one specific customer to support a customer-specific process.
• A marketplace integration is a standard integration that is made available to all Robaws customers in the Robaws integration marketplace.

The difference between the two lies in the authentication method. The requirements for a marketplace integration are slightly stricter.

I want to build a custom integration

For custom integrations, HTTP Basic Authentication is the recommended authentication method. We recommend you to create a separate user in the customers' Robaws environment. If you check the box 'API only', the user is free of charge. It is considered a best practice to create a separate role for that user, granting only access to the modules needed by the integration.
You then need to create an access key for this user. You can do that on the profile page. This access key and secret are used as basic authentication username and password.

Getting started

• Test tenants can be provided free of charge for 14 days. If needed this period can be extended.
• Questions about a new integration can be submitted through this form.

I want to build a marketplace integration

For marketplace integrations, the OAuth2 Authorization Code flow is the required authentication method. The requirements are:

• You do not refresh access tokens until they are (almost) expired.
• You build the integration against a Robaws test tenant first.
• In order for your integration to become available for production (in the Robaws marketplace), a demo video will be required where you demonstrate the integration.
• You'll need to provide us with an URL to the page where the customer can initiate the OAuth2 flow at your side.
• Polling is discouraged! If your integration should be aware of a change that happened, you should use the webhooks.

OAuth documentation

Getting started

• You can obtain a free test environment for 14 days. If necessary, this period can be extended upon mutual agreement. More information about obtaining a test account is available through this form.
• For a marketplace integration, you'll need an OAuth2 client ID & client secret. Contact us to get the credentials through this form.

Reference documentation

https://app.robaws.com/public/api-docs/robaws

Your API integration should take into account the Robaws rate limiting response headers. HTTP 429 errors will be monitored. If they occur too often, Robaws team will intervene to temporarily block the integration until you provide a solution. More details about the rate limiting can be found in the reference documentation.

Updates

See the API changelog

Specific topics

Webhooks
Request idempotency
API rate limiting
API filtering, paging & sorting
Updating information (PUT vs PATCH)
Uploading files
Calculeren via de API

Example use cases

• Creating a work order
• Synchronizing article data with your own database
• How to fetch invoices for import into accountancy software?

Example: creating a client/lead from a website form

If a customer has a website with a contact form, it can be convenient to integrate that form with the Robaws API so that incoming submissions are created directly as a client in Robaws.

Robaws lets you add custom fields to most of its entities. This feature is called 'extra fields' and it is referred to the same way in the API. If you have defined one or more extra fields on the client module, you can populate them straight away when creating the client with a POST /api/v2/clients request:

POST https://app.robaws.com/api/v2/clients
Authorization: Basic <base64(accessKey:secret)>
Content-Type: application/json

{
    "name": "John Doe",
    "extraFields": {
        "Contact via": {
            "stringValue": "Social media"
        }
    }
}

Every /api/v2 call must be authenticated. For a custom integration, use HTTP Basic Authentication with the access key and secret of a dedicated API user. Marketplace integrations use an OAuth 2 bearer token instead.

By default the extraFields object is keyed on the label of the extra field, so renaming a field in the settings will break your integration. To key on the stable internal reference instead, send the header x-robaws-extra-fields-mode: id.

Which value property you use depends on the field type:

Bijgewerkt op: 31/08/2026