Capabilities
| Resource | Sync | Provision |
|---|---|---|
| Participants | ||
| Companies | ||
| Plans |
Gather Shareworks credentials
Complete Shareworks API onboarding to obtain a client ID and register your
RSA public key with Shareworks.
Keep the matching RSA private key (PEM) available; the connector uses it to
sign the verification JWT that is exchanged for an access token.
Configuration fields
| Field | Required | Description |
|---|---|---|
environment | No | Shareworks environment to target: production or qa. Defaults to production. |
api-client-id | Yes | Shareworks client identifier issued during onboarding. Used as the JWT issuer claim. |
private-key | Yes | RSA private key (PEM) used to sign the verification JWT. |
key-id | No | Optional key identifier (kid) assigned during onboarding. |
Synced resource types
- Participants: equity plan participants from
GET /rest/admin/v1/participants. - Companies: administering companies from
GET /rest/admin/v1/companies. - Plans: equity and stock plans from
GET /rest/admin/v1/plans. - Company membership grants: participants are emitted as company member grants, and company administrators receive an additional admin grant.
- Plan membership grants: enrolled participants are emitted as plan member grants.
Special notes
- All Shareworks resource types are opt-in.
- Company and plan memberships are not separate resources; they are grant edges on the company and plan resources.
- Authentication is a two-step exchange: the connector signs a verification JWT with the client RSA private key and exchanges it for a short-lived access token, which is cached and refreshed before expiry.
- List endpoints use
offsetandlimitpagination. - On rate limit responses, the connector retries with exponential backoff.
Configure the Shareworks connector
- Cloud-hosted
- Self-hosted
Follow these instructions to use a built-in, no-code connector hosted by C1.Done. Your Shareworks connector is now pulling access data into C1.
Enter the Shareworks credentials:
- Environment:
productionorqa. - Client ID: the client identifier from onboarding.
- Private key (PEM): the RSA private key matching your registered public key.
- Key ID: the optional key identifier, if assigned.