Skip to main content

OpenProject source

Introduction​

The OpenProject source connector connects to the OpenProject API (v3) for an OpenProject Cloud instance (https://{instance}.openproject.com).

This connector is currently in development. Authentication can be validated, but data extraction is not yet available.

Setup​

Prerequisites​

  • An OpenProject Cloud account/tenant (the subdomain portion of your OpenProject URL).
  • An OpenProject API key.

Get your OpenProject instance identifier​

Your instance identifier is the subdomain in your OpenProject Cloud URL:

  • URL: https://acme.openproject.com
  • instance: acme

The connector requires instance to be a valid DNS label:

  • lowercase letters (a-z), digits (0-9), and hyphens (-) only
  • 1–63 characters
  • cannot start or end with -

Create an API key​

Create an API key in OpenProject and copy it for use in the connector configuration.

Authentication​

This connector authenticates using HTTP Basic Auth against the OpenProject API:

  • Username: apikey
  • Password: your OpenProject API key

During connection testing, the connector validates credentials by calling:

  • GET https://{instance}.openproject.com/api/v3/users/me

Configuration​

FieldTypeRequiredDescription
instancestring✅Your OpenProject Cloud instance identifier (subdomain), e.g. acme for https://acme.openproject.com. Must be a valid DNS label (lowercase letters/digits/hyphens; 1–63 chars; no leading/trailing hyphen).
api_keystring✅OpenProject API key used for Basic Auth (username apikey).

Streams​

No streams are currently available. The connector does not yet implement extraction.