Skip to main content

Workable source

Overview

The Workable source connector connects to the Workable API (SPI v3) using your Workable subdomain and an API access token.

Status

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

Setup

Prerequisites

  • A Workable account with access to your organization’s Workable subdomain (the {subdomain} in https://{subdomain}.workable.com)
  • A Workable API access token with permission to access the SPI v3 API

Get your Workable subdomain

Your Workable subdomain is the DNS label used in your Workable URL:

  • Example URL: https://acme.workable.com
  • Subdomain value: acme

The connector validates that the subdomain is a valid DNS label:

  • 1–63 characters
  • Letters, numbers, and hyphens only (a-z, 0-9, -)
  • Cannot start or end with a hyphen

Create an access token

Generate a Workable API access token in Workable (per your organization’s API settings). Use the token value as access_token in the connector configuration.

Authentication

This connector uses Bearer token authentication.

During credential validation, the connector calls:

GET https://{subdomain}.workable.com/spi/v3/members

and includes the header:

Authorization: Bearer <access_token>

If the request fails, the connector reports a credential validation error.

Configuration

FieldTypeRequiredDescription
subdomainstringYour Workable subdomain (DNS label), e.g. acme for https://acme.workable.com.
access_tokenstringWorkable API access token used as a Bearer token.

Streams

No streams are currently exposed. The connector’s extraction logic is still in development.

Limitations

  • Extraction not available yet: runs will fail if you attempt to extract data.
  • Catalog not available yet: the connector does not currently return a populated catalog of streams/schemas.