← API reference
Mutation / integrations

setIntegrationInstanceSecret

Set one secret on an integration instance. Secrets are not settable through config — this is the only way in. Requires integrationInstance:write permission.

Arguments

TypeID of the integration instance.

keyString!

Config key to set. Must be declared a secret by the definition's schema (x-input-type: password); see the instance's secrets.

valueString!

The secret. Stored encrypted and never returned by any query.

Returns IntegrationInstancePayload!

Explore in a view

Integrations
View exact SDL
"""
Set one secret on an integration instance. Secrets are not settable through `config` — this is the only way in. Requires integrationInstance:write permission.
"""
setIntegrationInstanceSecret(
  """TypeID of the integration instance."""
  id: IntegrationInstanceID!
  """
  Config key to set. Must be declared a secret by the definition's schema (`x-input-type: password`); see the instance's `secrets`.
  """
  key: String!
  """The secret. Stored encrypted and never returned by any query."""
  value: String!
): IntegrationInstancePayload! @topic(names: ["integrations"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.