integrationUpdate Mutation

Integrations are a new feature currently in beta-test: this API is subject to change without notice. Visit App Builder NodeJS for more information on integrations in 4me.

Updates an existing integration.

Input Argument

integrationUpdate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

clientMutationId (String)

A unique identifier for the client performing the mutation.

compliance (String)

Compliance description of the integration.

description (String)

Description of the integration.

disabled (Boolean)

Whether the integration may not be used for new instances.

features (String)

Feature description of the integration.

id (ID!)

The node ID of the record to update.

name (String)

Name of the integration.

newScopes ([IntegrationScopeInput!])

Scopes of this integration

policyJwtAlg (WebhookPolicyJwtAlg)

The algorithm used for generating the policy for the integration's webhook.

policyJwtAudience (String)

The audience for the policy for the integration's webhook.

policyJwtClaimExpiresIn (Int)

The claim expiry time for the policy for the integration's webhook.

reference (String)

This reference can be used to link the integration to an instance using the 4me APIs or the 4me Import functionality.

scopesToDelete ([ID!])

Identifiers of scopes to remove from the integration.

serviceInstanceId (ID)

Identifier of the the service instance this instance is linked to.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

uiExtensionId (ID)

UI extension that is to be applied to the record.

uiExtensionVersionId (ID)

Identifier of the UI extension version that is linked to the integration.

webhookUriTemplate (String)

The URI for the integration's webhook. The placeholder {account} can be used to include the customer account id in the URI.

Return Fields

clientMutationId (String)

A unique identifier for the client performing the mutation.

errors ([ValidationError!])

Errors encountered during the mutation.

integration (Integration)

Record after mutation.