Skip to main content

Fulfil

Overview​

The Fulfil source connector connects to the Fulfil API using your workspace ID and an API key.

Status / limitations​

This connector is currently in development:

  • Connection/authentication validation is supported.
  • Schema discovery currently returns an empty catalog.
  • Data extraction is not yet available.

Setup​

Prerequisites​

  • A Fulfil account with access to the workspace you want to connect.
  • An API key with permission to access the Fulfil API.

Create an API key in Fulfil​

Create an API key in Fulfil (or obtain one from your Fulfil administrator). You will use it as a Bearer token for API requests.

Authentication​

This connector authenticates via:

  • Workspace ID: used to build the API base URL: https://{workspace_id}.fulfil.io/
  • API key: sent as a Bearer token in the Authorization header

During connection testing, the connector validates credentials by calling:

  • GET https://{workspace_id}.fulfil.io/api/v1/users/me

Configuration​

FieldTypeRequiredDescription
workspace_idstring✅Your Fulfil workspace ID. Must be a valid DNS label (see below).
api_keystring✅Fulfil API key used as a Bearer token.

workspace_id format requirements​

workspace_id must be a valid DNS label:

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

Examples:

  • Valid: acme, acme-warehouse-1
  • Invalid: -acme, acme-, acme_warehouse, (empty)

Streams​

No streams are currently exposed by this connector.

Troubleshooting​

  • Credential validation failed
    • Confirm the workspace_id is correct and matches your Fulfil subdomain.
    • Confirm the API key is valid and has access to the workspace.
    • Ensure your network allows outbound HTTPS to *.fulfil.io.