Appearance
Credential Vault
In the dashboard, this vault lives under Connections → Credentials.
Most sources don't take a raw secret inline. Instead they reference a secret stored in the named credential vault by its id. You create the credential once, then point one or more sources at it. The secret is not written into the source config, and the API does not return it again.
The vault is org-scoped and admin-only: every endpoint requires an org admin. Credentials are shared between the sensors that ingest and the Workers that act — anything consuming the same secret shape reuses one credential (a GitHub PAT, for example, is one github_token credential whether a GitHub sensor reads with it or a GitHub-issue Worker writes with it).
Credential types
Each credential has a type that declares its shape. The types a source can reference:
| Type | Used by | Secret shape |
|---|---|---|
github_token | GitHub source | GitHub PAT with read access to the org/repos |
slack_bot_token | Slack sensor; slack_bot Worker delivery channel (UI label Slack Bot); @corveil chat | Bot token, xoxb-… (chat:write / reactions:write to deliver and ACK). On the official Corveil Slack app, Add to Slack creates this credential; the admin does not paste the token. |
slack_signing_secret | Bring-your-own Slack app only (slack_byo_app on, or Slack OAuth unset). Events API at /webhooks/slack/{token}. The official Corveil Slack app does not ask for this; events are verified with the deployment secret. | Signing Secret from the Slack app Basic Information page — not the bot token |
google_service_account_json | Google Meet, Google Calendar, Google Drive, Gmail, Google Chat sources | Full service-account key JSON |
jira_api_token | Jira and Confluence Cloud sources | Atlassian Cloud API token |
linear_api_key | Linear source | Linear personal API key (lin_api_…) |
asana_pat | Asana source | Asana personal access token (opaque; often 1/{gid}:{secret}) |
monday_api_token | Monday.com source | Monday.com personal API token |
notion_token | Notion source | Notion internal integration token (ntn_… or legacy secret_…) |
airtable_pat | Airtable source | Airtable personal access token (pat…). Not a retired API key or an OAuth access token. |
figma_access_token | Figma source | Figma personal access token (figd_…, sent as X-Figma-Token) or OAuth access token (sent as Bearer). Team, folder, and file IDs are sensor config. |
zoom_s2s_oauth | Zoom Transcripts source | Zoom Server-to-Server OAuth JSON: {"account_id","client_id","client_secret"} |
atlassian_dc_pat | Jira Data Center and Confluence Data Center sources | Data Center personal access token (opaque; no ATATT prefix) |
shellcrm_api_key | shell-crm source | shell-crm API key (client_id:client_secret) |
microsoft_graph | Microsoft Teams, SharePoint / OneDrive, Outlook Calendar, Outlook (email), and Microsoft Entra ID sources | Entra ID app registration as JSON: {"tenant_id","client_id","client_secret"} |
microsoft_graph_delegated | OneNote source | Delegated sign-in as JSON: {"tenant_id","client_id","client_secret"?,"refresh_token"}. The refresh token rotates on every use and Corveil writes the new one back. |
gitlab_token | GitLab source | GitLab personal / group / project access token (glpat-…); read_api |
bitbucket_access_token | Bitbucket source | Bitbucket Cloud access token (preferred), app password, or Atlassian API token |
hubspot_access_token | HubSpot source | HubSpot private-app token or account Service Key (pat-…) |
intercom_access_token | Intercom source | Intercom private-app access token (Authorization: Bearer). Not an OAuth marketplace token. |
zoominfo_pki | ZoomInfo source | ZoomInfo Enterprise API client for PKI authentication, as JSON: {"username", "client_id", "private_key"} (PEM RSA key from the ZoomInfo Admin Portal). The sensor signs a short client JWT with the key; a password is refused. |
salesforce_connected_app | Salesforce source | Connected App JSON: {"login_url","client_id","client_secret"} |
greenhouse_harvest_api_key | Greenhouse source | Greenhouse Harvest API key (HTTP Basic username, empty password). Not a Job Board token. |
lever_api_key | Lever source | Lever API key (HTTP Basic username, empty password). Not an OAuth partner token. |
workday_api_client | Workday source | Workday API Client JSON: {"host","tenant","client_id","client_secret","refresh_token"} |
pagerduty_api_key | PagerDuty source | PagerDuty REST API key (Authorization: Token token=…). Not an OAuth access token. |
azure_devops_credentials | Azure DevOps source | JSON with exactly one form: {"pat"} (personal access token, Services or Server) or {"tenant_id","client_id","client_secret"} (Entra ID service principal, Services only). The organization URL is sensor config. |
servicenow_credentials | ServiceNow source | JSON with exactly one pair: {"username","password"} (Basic, integration user) or {"client_id","client_secret"} (OAuth client credentials). The instance URL is sensor config. |
zendesk_api_token | Zendesk source | Zendesk API token (HTTP Basic username {email}/token). Agent email and subdomain are sensor config, not this secret. |
bamboohr_api_key | BambooHR source | BambooHR API key (HTTP Basic username, password x). Company subdomain is sensor config, not this secret. |
rippling_api_token | Rippling source | Rippling REST API token (Authorization: Bearer). Not an OAuth app-install token. |
gusto_api_client | Gusto source | Gusto App Integrations OAuth JSON: {"client_id","client_secret","refresh_token","redirect_uri","environment"?}. Refresh tokens are single-use; Corveil rotates the vault row after mint. |
okta_service_app | Okta source | Okta API Services app JSON: {"client_id","private_key","key_id"?}. private_key is the app's PEM RSA private key (private-key JWT client auth); no client secret. Scopes okta.users.read + okta.groups.read. |
okta_api_token | Okta source | Okta SSWS API token (Authorization: SSWS), created by a Read-Only Administrator. Use this or okta_service_app. Org URL is sensor config, not this secret. |
gong_access_key | Gong source | JSON {"access_key","access_key_secret"} from Gong Company Settings → API |
otter_api_key | Otter.ai source | Otter Public API key (Authorization: Bearer), Enterprise workspaces only. From otter.ai → Integrations → Developer → Create key. Acts as its user. |
fireflies_api_key | Fireflies source | Fireflies.ai API key (Authorization: Bearer), one per user. From app.fireflies.ai → Settings → Developer settings. Reads the meetings that user can see. |
granola_api_key | Granola source | Granola public-API key (grn_…, Authorization: Bearer), personal or workspace. From the Granola desktop app → Settings → Connectors → API keys. |
box_client_credentials | Box source | Box Platform app (Server Authentication, Client Credentials Grant) as JSON: {"client_id","client_secret","enterprise_id"}. Not a JWT config.json or a developer token. |
dropbox_team_oauth | Dropbox source | Team-scoped Dropbox app as JSON: {"app_key","app_secret","refresh_token"}. The refresh token comes from a team admin authorizing the app with token_access_type=offline; a short-lived sl.… access token is refused. |
lucid_credentials | Lucid source | Lucid credential as JSON, one of two forms: {"api_key"} (a Lucid API key with the DocumentReadonly grant) or {"client_id","client_secret","refresh_token"} (an OAuth 2.0 user token granted with offline_access). Refresh tokens are single-use; Corveil rotates the vault row after each refresh. Reads what that one Lucid user can see. |
aws_access_key | Amazon S3 source | JSON {"access_key_id","secret_access_key","session_token"?}. Required on Corveil Cloud. A self-hosted deployment can allow a blank credential (the AWS default chain) with CORVEIL_SENSOR_AMBIENT_CREDENTIALS=true; see Amazon S3. |
Other types (slack_webhook, generic_webhook) exist for Worker delivery channels and are not referenced by sensors. The Jenkins and Webhook sources use no vault credential — their webhook tokens are generated server-side at create time.
The live list for your instance:
bash
curl -sS https://your-corveil-host/api/credentials/types \
-H "Authorization: Bearer <admin-session-or-key>"Returns each registered type with its human-readable display name.
Create a credential
POST /api/credentials
json
{
"type": "github_token",
"name": "acme-readonly-pat",
"secret": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}bash
curl -sS -X POST https://your-corveil-host/api/credentials \
-H "Authorization: Bearer <admin-session-or-key>" \
-H "Content-Type: application/json" \
-d '{"type":"github_token","name":"acme-readonly-pat","secret":"ghp_..."}'The response echoes the stored credential's metadata — including its id — but never the secret. The secret is validated at write time for the given type, so a malformed value is rejected with a 400 before it lands in the vault.
Copy the returned id; that's what you put in a source's credentials block.
List, read, update, delete
| Method & path | Purpose |
|---|---|
GET /api/credentials | List all credentials (metadata only). Add ?type=github_token to filter. |
GET /api/credentials/{id} | Fetch one credential's metadata. |
PATCH /api/credentials/{id} | Rename ({"name": "..."}) or rotate the secret ({"secret": "..."}). |
DELETE /api/credentials/{id} | Remove a credential. |
How a source references a credential
When you create a source, the credentials block holds the credential id (a UUID), not the secret:
json
{
"sensor_type": "github",
"name": "Acme GitHub",
"config": { "org": "acme" },
"credentials": { "token": "6f1c2b8e-0a4d-4d6a-9f2e-1c3b5a7d9e11" }
}The token key is the credential field the GitHub source declares; its value is the id returned by POST /api/credentials. Every source guide in this section lists exactly which credential type its credential field expects.
The Add sensor UI renders a dropdown of matching credentials for each credential field, so you rarely assemble this JSON by hand — but the same shape is what the API expects for programmatic setup.