Skip to main content

Set Integration Credentials (Admin)

Set or rotate an integration credential for the calling org. Upserts the configured_integrations row. Requires an admin-scoped API key. Returns metadata; never echoes the credential value.

Parameters

NameTypeDefaultDescription
integration_key Requiredstring-Catalog key for the integration to configure (e.g., 'hginsights_v2', 'salesforce').
value Requiredstring-Credential value to store. Treated as a secret — never echoed in responses, redacted from telemetry.

Use Cases

  • Connect the org to HG Insights v2 by storing its API key
  • Rotate an integration credential (e.g. after a key leak) — upserts the existing row

Example Usage

Configure the HG Insights v2 integration

{
"tool": "admin_set_integration_credentials",
"arguments": {
"integration_key": "hginsights_v2",
"value": "<secret-api-key>"
}
}

Response Format

FieldTypeDescription
keystringIntegration catalog key that was configured.
isConfiguredbooleanAlways true on success.
hasCredentialsbooleanAlways true on success.
updatedAtstringWhen the credential was stored/rotated.