Skip to content
RedirHub/API
Sign inGet API key
Workspace · workspace.integrationKey
POST/workspace/integration-keyworkspace.integrationKey

The workspace's integration key, created when it has none. Integrations send it as `Authorization: Bearer <key>` when they report visits to the host's `integration.hits_url`; the same key serves every integration of the workspace. With `rotate` it is replaced: the old key stops at once and every rules file moves to a new address, so each integration needs the new key and its new rules URL. No other response carries the key. Managers and owners only

POST /workspace/integration-key is part of the Workspace group. Its parameters and response shape below are generated from the live OpenAPI document.

Base URL
https://api.redirhub.com/v1
Auth
Bearer token
Idempotent
No
Returns
application/json

The request

Send a JSON body to POST /workspace/integration-key. Every field is optional — send only what you want to set.

# The workspace's integration key, created when it has none. Integrations send it as
`Authorization: Bearer <key>` when they report visits to the host's `integration.hits_url`;
the same key serves every integration of the workspace. With `rotate` it is replaced: the
old key stops at once and every rules file moves to a new address, so each integration
needs the new key and its new rules URL. No other response carries the key. Managers and
owners only
curl -X POST "https://api.redirhub.com/v1/workspace/integration-key" \
  -H "Authorization: Bearer $REDIRHUB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "rotate": true
  }'

Body parameters

FieldDescription
rotateoptionalbooleanReplace the key: the old one stops working at once and every rules URL of the workspace changes.

The response

A 200 returns the record as JSON.

{
  "key": "string",
  "prefix": "string",
  "created_at": "2026-08-01T09:14:22Z"
}

Status codes

200
SuccessThe integration key; the workspace itself shows only its prefix and creation time (integration_key).
401
UnauthenticatedUnauthenticated
409
ConflictA request with the same Idempotency-Key is still running
422
Validation failedA field was rejected. errors lists every field with its reason.
429
Too many requestsToo many requests
484
Bad requestThe workspace role of the authenticated user is too low for this action.