Mutations

This page lists all available GraphQL mutation operations in alphabetical order.

administerObjectPermission

Administers a Permission to an object for the specified User.

mutation {
  administerObjectPermission(input: {}) {
    id
  }
}

Input fields (AdministerObjectPermissionInput!)

Argument	Type	Description
`grant`	`Boolean!`	Specifies whether to grant or revoke the specified Permission.
`permission`	`ID!`	The Permission to grant for the specified object.
`object`	`ID!`	The object for which the specified Permission is being granted.
`id`	`ID`	The ID of the User to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (AdministerObjectPermissionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

bulkDisableInstancesUsingConnection

Disables all Instances that reference the specified Scoped Config Variable

mutation {
  bulkDisableInstancesUsingConnection(input: {}) {
    id
  }
}

Input fields (BulkDisableInstancesUsingConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the ScopedConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (BulkDisableInstancesUsingConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

bulkDisableInstancesUsingCustomerConnection

Disables all Instances that reference the specified Customer Config Variable

mutation {
  bulkDisableInstancesUsingCustomerConnection(input: {}) {
    id
  }
}

Input fields (BulkDisableInstancesUsingCustomerConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (BulkDisableInstancesUsingCustomerConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

bulkUpdateInstancesToLatestIntegrationVersion

Updates all Instances that reference the specified Integration to the latest published version of the specified Integration. If the Instances are deployed, it will re-deploy them as necessary. Returns an instance of the latest version of the specified Integration.

mutation {
  bulkUpdateInstancesToLatestIntegrationVersion(input: {}) {
    id
  }
}

Input fields (BulkUpdateInstancesToLatestIntegrationVersionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (BulkUpdateInstancesToLatestIntegrationVersionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

changePassword

Allows the signed-in User to change their password.

mutation {
  changePassword(input: {}) {
    id
  }
}

Input fields (ChangePasswordInput!)

Argument	Type	Description
`currentPassword`	`String!`	The current password.
`newPassword`	`String!`	The new password.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ChangePasswordPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

clearAlertMonitor

Allows clearing a triggered AlertMonitor.

mutation {
  clearAlertMonitor(input: {}) {
    id
  }
}

Input fields (ClearAlertMonitorInput!)

Argument	Type	Description
`id`	`ID`	The ID of the AlertMonitor to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ClearAlertMonitorPayload)

Field	Type	Description
`alertMonitor`	`AlertMonitor`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

convertLowCodeIntegration

None

mutation {
  convertLowCodeIntegration(input: {}) {
    id
  }
}

Input fields (ConvertLowCodeIntegrationInput!)

Argument	Type	Description
`registryPrefix`	`String`	The registry prefix to use for the converted integration.
`registryUrl`	`String`	The registry URL to use for the converted integration.
`includeComments`	`Boolean`	Whether to include inline comments in the generated code.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ConvertLowCodeIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`convertLowCodeIntegrationFormResult`	`ConvertLowCodeIntegrationFormResult`
`errors`	`[ErrorType!]!`

createAlertGroup

Creates a new AlertGroup object.

mutation {
  createAlertGroup(input: {}) {
    id
  }
}

Input fields (CreateAlertGroupInput!)

Argument	Type	Description
`name`	`String`	The name of the AlertGroup
`users`	`[ID]`	The users in the AlertGroup.
`webhooks`	`[ID]`	The AlertWebhooks in the AlertGroup
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateAlertGroupPayload)

Field	Type	Description
`alertGroup`	`AlertGroup`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

createAlertMonitor

Creates a new AlertMonitor object.

mutation {
  createAlertMonitor(input: {}) {
    id
  }
}

Input fields (CreateAlertMonitorInput!)

Argument	Type	Description
`name`	`String!`	The name of the AlertMonitor.
`instance`	`ID`	The Instance that is being monitored by the AlertMonitor.
`flowConfig`	`ID`	The IntegrationFlow that is being monitored by the AlertMonitor.
`logSeverityLevelCondition`	`Int`	The log severity level condition to monitor for relevant AlertTrigger types.
`durationSecondsCondition`	`Int`	The execution duration condition to monitor for relevant AlertTrigger types.
`executionOverdueMinutesCondition`	`Int`	The execution overdue condition to monitor for relevant AlertTrigger types.
`triggers`	`[ID]`	The AlertTriggers that are setup to trigger the AlertMonitor.
`groups`	`[ID]`	The AlertGroups to notify when the AlertMonitor is triggered.
`users`	`[ID]`	The Users to notify when the AlertMonitor is triggered.
`webhooks`	`[ID]`	The AlertWebhooks to call when the AlertMonitor is triggered.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateAlertMonitorPayload)

Field	Type	Description
`alertMonitor`	`AlertMonitor`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

createAlertWebhook

Creates a new AlertWebhook object.

mutation {
  createAlertWebhook(input: {}) {
    id
  }
}

Input fields (CreateAlertWebhookInput!)

Argument	Type	Description
`name`	`String!`	The name of the AlertWebhook.
`url`	`String!`	The URL of the AlertWebhook.
`payloadTemplate`	`String!`	The template that is hydrated and then used as the body of the AlertWebhook request.
`headers`	`String`	A JSON string of key/value pairs that will be sent as headers in the Webhook request.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateAlertWebhookPayload)

Field	Type	Description
`alertWebhook`	`AlertWebhook`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

createConnectionTemplate

Creates a new ConnectionTemplate object.

mutation {
  createConnectionTemplate(input: {}) {
    id
  }
}

Input fields (CreateConnectionTemplateInput!)

Argument	Type	Description
`connection`	`ID!`	The Connection from which this template is structured.
`name`	`String!`	The name of this template.
`presets`	`[ConnectionTemplateField]!`	The input presets associated with this template.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateConnectionTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`connectionTemplate`	`ConnectionTemplate`
`errors`	`[ErrorType!]!`

createCustomer

Creates a new Customer object.

mutation {
  createCustomer(input: {}) {
    id
  }
}

Input fields (CreateCustomerInput!)

Argument	Type	Description
`name`	`String!`	The name of the Customer, which must be unique within the scope of its Organization.
`description`	`String`	Additional notes about the Customer.
`allowEmbeddedDesigner`	`Boolean`	Specifies whether this Customer can use the Embedded Designer.
`labels`	`[String]`	The labels that are associated with the object.
`externalId`	`String`	Allows for mapping an external entity to a Prismatic record.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateCustomerPayload)

Field	Type	Description
`clientMutationId`	`String`
`customer`	`Customer`
`errors`	`[ErrorType!]!`

createCustomerConfigVariable

Creates a new CustomerConfigVariable object.

mutation {
  createCustomerConfigVariable(input: {}) {
    id
  }
}

Input fields (CreateCustomerConfigVariableInput!)

Argument	Type	Description
`key`	`String`	The display name of this variable.
`scopedConfigVariable`	`ID!`	The Scoped Config Variable with which this Config Variable is associated.
`customer`	`ID`	The Customer with which this Config Variable is associated.
`isTest`	`Boolean`	Specifies whether this Config Variable is meant for testing.
`inputs`	`[InputExpression]`	The collection of Expressions that serve as inputs to this variable.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateCustomerConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

createCustomerCredential

DEPRECATED.

mutation {
  createCustomerCredential(input: {}) {
    id
  }
}

Input fields (CreateCustomerCredentialInput!)

Argument	Type	Description
`authorizationMethod`	`ID!`	The specific AuthorizationMethod used by the Credential.
`customer`	`ID`	The Customer the Credential belongs to, if any. If NULL then Organization will be specified.
`label`	`String!`	The name of the Credential.
`values`	`[InputCredentialFieldValue]`	A list of InputCredentialFieldValues that contain the values for the CredentialFields.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateCustomerCredentialPayload)

Field	Type	Description
`clientMutationId`	`String`
`credential`	`Credential`
`errors`	`[ErrorType!]!`

createCustomerUser

Creates a User for the specified Customer.

mutation {
  createCustomerUser(input: {}) {
    id
  }
}

Input fields (CreateCustomerUserInput!)

Argument	Type	Description
`email`	`String!`	The email address associated with the User.
`name`	`String`	The user's preferred name.
`customer`	`ID`	The Customer the user belongs to, if any. If this is NULL then Organization will be specified.
`role`	`ID!`
`phone`	`String`	The preferred contact phone number for the User.
`externalId`	`String`	Allows for mapping an external entity to a Prismatic record.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateCustomerUserPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

createExternalLogStream

Creates a new ExternalLogStream object.

mutation {
  createExternalLogStream(input: {}) {
    id
  }
}

Input fields (CreateExternalLogStreamInput!)

Argument	Type	Description
`name`	`String!`	Name of the ExternalLogStream.
`url`	`String!`	The URL of the ExternalLogStream.
`payloadTemplate`	`String!`	The template that is hydrated and then used as the body of the ExternalLogStream request.
`headers`	`String`	A JSON string of key/value pairs that will be sent as headers in the ExternalLogStream request.
`severityLevels`	`[LogSeverityLevelInput]!`	The Log severity levels for which Logs should be sent to the ExternalLogStream.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateExternalLogStreamPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`externalLogStream`	`ExternalLogStream`

createInstance

Creates a new Instance object.

mutation {
  createInstance(input: {}) {
    id
  }
}

Input fields (CreateInstanceInput!)

Argument	Type	Description
`description`	`String`	Additional notes about the Instance.
`customer`	`ID!`	The Customer for which the Instance is deployed.
`integration`	`ID!`	The Integration that has been deployed for the Instance.
`name`	`String!`	The name of the Instance.
`labels`	`[String]`	The labels that are associated with the object.
`configVariables`	`[InputInstanceConfigVariable]`	Config variable values that are associated with the Instance.
`flowConfigs`	`[InputInstanceFlowConfig]`	Configuration data for each IntegrationFlow that is associated with the Instance.
`configMode`	`String`	Desired configuration mode.
`logsDisabled`	`Boolean`	This field is deprecated.
`stepResultsDisabled`	`Boolean`	This field is deprecated.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateInstancePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

createInstanceProfile

Creates a new InstanceProfile object.

mutation {
  createInstanceProfile(input: {}) {
    id
  }
}

Input fields (CreateInstanceProfileInput!)

Argument	Type	Description
`name`	`String!`	The name of the Instance Profile, which must be unique within the scope of its Organization.
`description`	`String`	Additional notes about the Instance Profile.
`isDefaultProfile`	`Boolean`	Specifies whether this Instance Profile is the default used when no Instance Profile is explicitly specified during Instance creation.
`logsDisabled`	`Boolean`	Specifies whether to disable the creation of logs during Instance execution.
`stepResultsDisabled`	`Boolean`	Specifies whether to disable the creation of step results during Instance execution.
`allocatedMemoryMb`	`Int!`	The amount of memory allocated to the Instance Runner Lambda function.
`instanceBillingType`	`String!`	The billing type for the Instances that use this Instance Profile.
`quickStart`	`Boolean`	DEPRECATED: Use quick_start_instances instead. Whether instances using this profile will startup faster when triggered.
`quickStartInstances`	`Int`	The number of QuickStart runners reserved for instances using this profile.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateInstanceProfilePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceProfile`	`InstanceProfile`

createIntegration

Creates a new Integration object.

mutation {
  createIntegration(input: {}) {
    id
  }
}

Input fields (CreateIntegrationInput!)

Argument	Type	Description
`name`	`String!`	The name of the Integration.
`description`	`String`	Additional notes about the Integration.
`customer`	`ID`	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
`endpointConfigTestPayload`	`String`	Data payload for testing the endpoint configuration for this Integration.
`endpointConfigTestContentType`	`String`	Content type of the payload for testing the endpoint configuration for this Integration.
`endpointConfigTestHeaders`	`String`	A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
`metadata`	`String`	A JSON string that represents metadata for the Integration.
`labels`	`[String]`	The labels that are associated with the object.
`definition`	`String`	The YAML serialized definition of the Integration to import.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

createOnPremiseResourceJWT

Creates a JWT that is used to perform registration of an On-Prem Resource. Rather than being short-lived, it is valid until the identity_key is changed.

mutation {
  createOnPremiseResourceJWT(input: {}) {
    id
  }
}

Input fields (CreateOnPremiseResourceJWTInput!)

Argument	Type	Description
`customerId`	`ID`	The Customer associated with this resource.
`orgOnly`	`Boolean`	Set to true to register an On-Prem Resource only available to Organization users. Only valid for Organization users.
`resourceId`	`ID`	An optional ID of an existing On-Prem Resource for which to generate a new JWT.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateOnPremiseResourceJWTPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`result`	`CreateOnPremiseResourceJWTResult`

createOrganizationCredential

DEPRECATED.

mutation {
  createOrganizationCredential(input: {}) {
    id
  }
}

Input fields (CreateOrganizationCredentialInput!)

Argument	Type	Description
`authorizationMethod`	`ID!`	The specific AuthorizationMethod used by the Credential.
`label`	`String!`	The name of the Credential.
`values`	`[InputCredentialFieldValue]`	A list of InputCredentialFieldValues that contain the values for the CredentialFields.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateOrganizationCredentialPayload)

Field	Type	Description
`clientMutationId`	`String`
`credential`	`Credential`
`errors`	`[ErrorType!]!`

createOrganizationSigningKey

Creates a Signing Key for the Organization of the signed-in User.

mutation {
  createOrganizationSigningKey(input: {}) {
    id
  }
}

Input fields (CreateOrganizationSigningKeyInput!)

Argument	Type	Description
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateOrganizationSigningKeyPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`result`	`CreateOrganizationSigningKeyResult`

createOrganizationUser

Creates a User for the Organization of the signed-in User.

mutation {
  createOrganizationUser(input: {}) {
    id
  }
}

Input fields (CreateOrganizationUserInput!)

Argument	Type	Description
`email`	`String!`	The email address associated with the User.
`name`	`String`	The user's preferred name.
`role`	`ID!`	The Role to associate with the User.
`phone`	`String`	The preferred contact phone number for the User.
`externalId`	`String`	Allows for mapping an external entity to a Prismatic record.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateOrganizationUserPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

createScopedConfigVariable

Creates a new ScopedConfigVariable object.

mutation {
  createScopedConfigVariable(input: {}) {
    id
  }
}

Input fields (CreateScopedConfigVariableInput!)

Argument	Type	Description
`key`	`String!`	The display name of this variable.
`stableKey`	`String!`	The stable key for referencing this variable from Integrations. Cannot change after setting.
`description`	`String`	Additional notes about the Scoped Config Variable.
`variableScope`	`String!`	Specifies the scope of the variable.
`managedBy`	`String`	Enforces which group of users can modify the variable.
`connection`	`ID!`	The Connection to which this variable is associated.
`customer`	`ID`	The Customer with which this Config Variable is associated.
`inputs`	`[InputExpression]`	The collection of Expressions that serve as inputs to this variable.
`oAuthRedirectConfig`	`OAuthRedirectConfigInput`	Configuration for OAuth redirects.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateScopedConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

createTestCase

Create a new TestCase.

mutation {
  createTestCase(input: {}) {
    id
  }
}

Input fields (CreateTestCaseInput!)

Argument	Type	Description
`integration`	`ID!`	The Integration this TestCase belongs to.
`flow`	`ID`	The IntegrationFlow this TestCase belongs to.
`name`	`String!`	The name of the TestCase.
`contentType`	`String`	Content type of the test payload.
`payload`	`String`	Test step payload data.
`headers`	`String`	Test headers as key/value pairs.
`result`	`String`	Test step result data.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateTestCasePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testCase`	`TestCase`

createUserLevelConfig

Creates a new UserLevelConfig object.

mutation {
  createUserLevelConfig(input: {}) {
    id
  }
}

Input fields (CreateUserLevelConfigInput!)

Argument	Type	Description
`instance`	`ID!`	The Instance with which the User Level Config is associated.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateUserLevelConfigPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`userLevelConfig`	`UserLevelConfig`

createWebhookEndpoint

Creates a new WebhookEndpoint object.

mutation {
  createWebhookEndpoint(input: {}) {
    id
  }
}

Input fields (CreateWebhookEndpointInput!)

Argument	Type	Description
`name`	`String!`	Friendly name for the webhook endpoint.
`url`	`String!`	The URL where webhook events will be sent.
`description`	`String`	Additional notes about this webhook endpoint configuration.
`secret`	`String`	Secret key used for HMAC signature generation. If provided, all webhook payloads will include an X-Webhook-Signature header.
`headers`	`String`	A JSON object of key/value pairs that will be sent as headers with each webhook request.
`enabled`	`Boolean`	Whether this webhook endpoint is currently enabled. Disabled endpoints will not receive events.
`eventTypes`	`[String]!`	List of event types to subscribe to.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (CreateWebhookEndpointPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`webhookEndpoint`	`WebhookEndpoint`

deleteAlertGroup

Removes the specified AlertGroup object.

mutation {
  deleteAlertGroup(input: {}) {
    id
  }
}

Input fields (DeleteAlertGroupInput!)

Argument	Type	Description
`id`	`ID`	The ID of the AlertGroup to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteAlertGroupPayload)

Field	Type	Description
`alertGroup`	`AlertGroup`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

deleteAlertMonitor

Removes the specified AlertMonitor object.

mutation {
  deleteAlertMonitor(input: {}) {
    id
  }
}

Input fields (DeleteAlertMonitorInput!)

Argument	Type	Description
`id`	`ID`	The ID of the AlertMonitor to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteAlertMonitorPayload)

Field	Type	Description
`alertMonitor`	`AlertMonitor`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

deleteAlertWebhook

Removes the specified AlertWebhook object.

mutation {
  deleteAlertWebhook(input: {}) {
    id
  }
}

Input fields (DeleteAlertWebhookInput!)

Argument	Type	Description
`id`	`ID`	The ID of the AlertWebhook to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteAlertWebhookPayload)

Field	Type	Description
`alertWebhook`	`AlertWebhook`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

deleteComponent

Removes the specified Component object.

mutation {
  deleteComponent(input: {}) {
    id
  }
}

Input fields (DeleteComponentInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Component to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteComponentPayload)

Field	Type	Description
`clientMutationId`	`String`
`component`	`Component`
`errors`	`[ErrorType!]!`

deleteConnectionTemplate

Removes the specified ConnectionTemplate object.

mutation {
  deleteConnectionTemplate(input: {}) {
    id
  }
}

Input fields (DeleteConnectionTemplateInput!)

Argument	Type	Description
`id`	`ID`	The ID of the ConnectionTemplate to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteConnectionTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`connectionTemplate`	`ConnectionTemplate`
`errors`	`[ErrorType!]!`

deleteCredential

DEPRECATED.

mutation {
  deleteCredential(input: {}) {
    id
  }
}

Input fields (DeleteCredentialInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Credential to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteCredentialPayload)

Field	Type	Description
`clientMutationId`	`String`
`credential`	`Credential`
`errors`	`[ErrorType!]!`

deleteCustomer

Removes the specified Customer object.

mutation {
  deleteCustomer(input: {}) {
    id
  }
}

Input fields (DeleteCustomerInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Customer to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteCustomerPayload)

Field	Type	Description
`clientMutationId`	`String`
`customer`	`Customer`
`errors`	`[ErrorType!]!`

deleteCustomerConfigVariable

Removes the specified CustomerConfigVariable object.

mutation {
  deleteCustomerConfigVariable(input: {}) {
    id
  }
}

Input fields (DeleteCustomerConfigVariableInput!)

Argument	Type	Description
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteCustomerConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

deleteExternalLogStream

Removes the specified ExternalLogStream object.

mutation {
  deleteExternalLogStream(input: {}) {
    id
  }
}

Input fields (DeleteExternalLogStreamInput!)

Argument	Type	Description
`id`	`ID`	The ID of the ExternalLogStream to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteExternalLogStreamPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`externalLogStream`	`ExternalLogStream`

deleteInstance

Removes the specified Instance object.

mutation {
  deleteInstance(input: {}) {
    id
  }
}

Input fields (DeleteInstanceInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteInstancePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

deleteInstanceProfile

Removes the specified InstanceProfile object.

mutation {
  deleteInstanceProfile(input: {}) {
    id
  }
}

Input fields (DeleteInstanceProfileInput!)

Argument	Type	Description
`id`	`ID`	The ID of the InstanceProfile to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteInstanceProfilePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceProfile`	`InstanceProfile`

deleteIntegration

Removes the specified Integration object.

mutation {
  deleteIntegration(input: {}) {
    id
  }
}

Input fields (DeleteIntegrationInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

deleteIntegrationTemplate

Delete a standard IntegrationTemplate.

This mutation pertains to standard IntegrationTemplates, not the case of marking an Integration as a template. If you have an Integration marked as a template that you wish to remove, use UpdateIntegration.

mutation {
  deleteIntegrationTemplate(input: {}) {
    id
  }
}

Input fields (DeleteIntegrationTemplateInput!)

Argument	Type	Description
`id`	`ID`	The ID of the WorkflowTemplate to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteIntegrationTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integrationTemplate`	`WorkflowTemplate`

deleteOnPremiseResource

Removes the specified OnPremiseResource object.

mutation {
  deleteOnPremiseResource(input: {}) {
    id
  }
}

Input fields (DeleteOnPremiseResourceInput!)

Argument	Type	Description
`id`	`ID`	The ID of the OnPremiseResource to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteOnPremiseResourcePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`onPremiseResource`	`OnPremiseResource`

deleteOrganization

Removes the specified Organization object.

mutation {
  deleteOrganization(input: {}) {
    id
  }
}

Input fields (DeleteOrganizationInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Organization to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteOrganizationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`organization`	`Organization`

deleteOrganizationSigningKey

Deletes the specified Signing Key.

mutation {
  deleteOrganizationSigningKey(input: {}) {
    id
  }
}

Input fields (DeleteOrganizationSigningKeyInput!)

Argument	Type	Description
`id`	`ID`	The ID of the OrganizationSigningKey to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteOrganizationSigningKeyPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`organizationSigningKey`	`OrganizationSigningKey`

deleteScopedConfigVariable

Removes the specified ScopedConfigVariable object.

mutation {
  deleteScopedConfigVariable(input: {}) {
    id
  }
}

Input fields (DeleteScopedConfigVariableInput!)

Argument	Type	Description
`id`	`ID`	The ID of the ScopedConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteScopedConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

deleteTestCase

Delete a TestCase.

mutation {
  deleteTestCase(input: {}) {
    id
  }
}

Input fields (DeleteTestCaseInput!)

Argument	Type	Description
`id`	`ID`	The ID of the TestCase to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteTestCasePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testCase`	`TestCase`

deleteUser

Removes the specified User object.

mutation {
  deleteUser(input: {}) {
    id
  }
}

Input fields (DeleteUserInput!)

Argument	Type	Description
`id`	`ID`	The ID of the User to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteUserPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

deleteUserLevelConfig

Removes the specified UserLevelConfig object.

mutation {
  deleteUserLevelConfig(input: {}) {
    id
  }
}

Input fields (DeleteUserLevelConfigInput!)

Argument	Type	Description
`id`	`ID`	The ID of the UserLevelConfig to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteUserLevelConfigPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`userLevelConfig`	`UserLevelConfig`

deleteWebhookEndpoint

Removes the specified WebhookEndpoint object.

mutation {
  deleteWebhookEndpoint(input: {}) {
    id
  }
}

Input fields (DeleteWebhookEndpointInput!)

Argument	Type	Description
`id`	`ID`	The ID of the WebhookEndpoint to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteWebhookEndpointPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`webhookEndpoint`	`WebhookEndpoint`

deleteWorkflow

Removes the specified Integration object.

mutation {
  deleteWorkflow(input: {}) {
    id
  }
}

Input fields (DeleteWorkflowInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteWorkflowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

deleteWorkflowTemplate

Removes the specified WorkflowTemplate object.

mutation {
  deleteWorkflowTemplate(input: {}) {
    id
  }
}

Input fields (DeleteWorkflowTemplateInput!)

Argument	Type	Description
`id`	`ID`	The ID of the WorkflowTemplate to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeleteWorkflowTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integrationTemplate`	`WorkflowTemplate`

deployInstance

Deploys an Instance.

mutation {
  deployInstance(input: {}) {
    id
  }
}

Input fields (DeployInstanceInput!)

Argument	Type	Description
`force`	`Boolean`	When true, will deploy the instance, ignoring certain validation rules that would normally prevent deployment.
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DeployInstancePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

disableWorkflow

None

mutation {
  disableWorkflow(input: {}) {
    id
  }
}

Input fields (DisableWorkflowInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DisableWorkflowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

disconnectConnection

Disconnect the specified Connection.

mutation {
  disconnectConnection(input: {}) {
    id
  }
}

Input fields (DisconnectConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the InstanceConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DisconnectConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceConfigVariable`	`InstanceConfigVariable`

disconnectCustomerConnection

Disconnect the specified Customer Connection.

mutation {
  disconnectCustomerConnection(input: {}) {
    id
  }
}

Input fields (DisconnectCustomerConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DisconnectCustomerConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

disconnectScopedConnection

Disconnect the specified Scoped Connection.

mutation {
  disconnectScopedConnection(input: {}) {
    id
  }
}

Input fields (DisconnectScopedConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the ScopedConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DisconnectScopedConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

disconnectUserLevelConnection

Disconnect the specified User Level Connection.

mutation {
  disconnectUserLevelConnection(input: {}) {
    id
  }
}

Input fields (DisconnectUserLevelConnectionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the UserLevelConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (DisconnectUserLevelConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`userLevelConfigVariable`	`UserLevelConfigVariable`

enableWorkflow

None

mutation {
  enableWorkflow(input: {}) {
    id
  }
}

Input fields (EnableWorkflowInput!)

Argument	Type	Description
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (EnableWorkflowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

fetchConfigWizardPageContent

Populates content for relevant widgets on the specified configuration wizard page of the Integration that is associated with the specified Instance.

mutation {
  fetchConfigWizardPageContent(input: {}) {
    id
  }
}

Input fields (FetchConfigWizardPageContentInput!)

Argument	Type	Description
`pageName`	`String`	The name of the Configuration Page for which content should be fetched.
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (FetchConfigWizardPageContentPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`fetchConfigWizardPageContentResult`	`FetchConfigWizardPageContentResult`

fetchDataSourceContent

Populates content for a single Data Source in the context of the specified Instance.

mutation {
  fetchDataSourceContent(input: {}) {
    id
  }
}

Input fields (FetchDataSourceContentInput!)

Argument	Type	Description
`dataSource`	`ID`	The Data Source for which content should be fetched.
`inputs`	`[InputExpression]`	Input values for the specified Data Source.
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (FetchDataSourceContentPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`fetchDataSourceContentResult`	`FetchDataSourceContentResult`

forkIntegration

Forks an Integration.

mutation {
  forkIntegration(input: {}) {
    id
  }
}

Input fields (ForkIntegrationInput!)

Argument	Type	Description
`name`	`String!`	The name of the Integration.
`description`	`String`	Additional notes about the Integration.
`parent`	`ID!`	Parent Integration this Integration was forked from, if any
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ForkIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

importIntegration

Import an Integration.

mutation {
  importIntegration(input: {}) {
    id
  }
}

Input fields (ImportIntegrationInput!)

Argument	Type	Description
`customer`	`ID`	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
`definition`	`String!`	The YAML serialized definition of the Integration to import.
`integrationId`	`ID`	The ID of the Integration being imported.
`replace`	`Boolean`	Allows for replacing an existing low-code integration or CNI with one of the opposite type.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ImportIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

importIntegrationTemplate

Import a standard IntegrationTemplate from a YAML definition.

mutation {
  importIntegrationTemplate(input: {}) {
    id
  }
}

Input fields (ImportIntegrationTemplateInput!)

Argument	Type	Description
`definition`	`String!`	The YAML serialized definition of the IntegrationTemplate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ImportIntegrationTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`importResult`	`ImportIntegrationTemplateResult`

importOrganizationSigningKey

Creates a new OrganizationSigningKey object.

mutation {
  importOrganizationSigningKey(input: {}) {
    id
  }
}

Input fields (ImportOrganizationSigningKeyInput!)

Argument	Type	Description
`publicKey`	`String!`	Public key of the Signing Keypair.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ImportOrganizationSigningKeyPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`organizationSigningKey`	`OrganizationSigningKey`

importWorkflow

None

mutation {
  importWorkflow(input: {}) {
    id
  }
}

Input fields (ImportWorkflowInput!)

Argument	Type	Description
`definition`	`String!`	The YAML serialized definition of the Workflow to import.
`customer`	`ID`	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ImportWorkflowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`workflow`	`Workflow`

publishComponent

Publishes a Component.

mutation {
  publishComponent(input: {}) {
    id
  }
}

Input fields (PublishComponentInput!)

Argument	Type	Description
`customer`	`ID`	The Customer the Component belongs to, if any. If this is NULL then the Component belongs to the Organization.
`definition`	`ComponentDefinitionInput!`	The Component definition.
`actions`	`[ActionDefinitionInput]`	A list of Component Actions.
`triggers`	`[TriggerDefinitionInput]`	A list of Component Triggers.
`dataSources`	`[DataSourceDefinitionInput]`	A list of Component Data Sources.
`connections`	`[ConnectionDefinitionInput]`	A list of Component Connections.
`attributes`	`String`	Attributes to set on the published version.
`comment`	`String`	Comment about changes in this Publish.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (PublishComponentPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`publishResult`	`PublishComponentResult`

publishIntegration

Publishes an Integration.

mutation {
  publishIntegration(input: {}) {
    id
  }
}

Input fields (PublishIntegrationInput!)

Argument	Type	Description
`attributes`	`String`	Attributes to set on the published version.
`comment`	`String`	Comment about changes in this Publish.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (PublishIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

publishWorkflow

Publishes a Workflow.

mutation {
  publishWorkflow(input: {}) {
    id
  }
}

Input fields (PublishWorkflowInput!)

Argument	Type	Description
`comment`	`String`	Comment about changes in this published Workflow version.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (PublishWorkflowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`workflow`	`Workflow`

replayExecution

Replays an existing instance execution.

mutation {
  replayExecution(input: {}) {
    id
  }
}

Input fields (ReplayExecutionInput!)

Argument	Type	Description
`id`	`ID`	The ID of the InstanceExecutionResult to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ReplayExecutionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceExecutionResult`	`InstanceExecutionResult`

requestOAuth2CredentialAuthorization

DEPRECATED.

mutation {
  requestOAuth2CredentialAuthorization(input: {}) {
    id
  }
}

Input fields (RequestOAuth2CredentialAuthorizationInput!)

Argument	Type	Description
`email`	`String`	The email of the recipient who will complete the OAuth2 authorization request.
`message`	`String`	The message that will be sent to the recipient of the email.
`id`	`ID`	The ID of the Credential to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (RequestOAuth2CredentialAuthorizationPayload)

Field	Type	Description
`clientMutationId`	`String`
`credential`	`Credential`
`errors`	`[ErrorType!]!`

rotateOnPremiseResourceJWT

Rotates the identity_key of an On-Prem Resource and returns a new JWT.

mutation {
  rotateOnPremiseResourceJWT(input: {}) {
    id
  }
}

Input fields (RotateOnPremiseResourceJWTInput!)

Argument	Type	Description
`customerId`	`ID`	The Customer associated with this resource.
`orgOnly`	`Boolean`	Set to true to register an On-Prem Resource only available to Organization users. Only valid for Organization users.
`resourceId`	`ID!`	The ID of the On-Prem Resource.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (RotateOnPremiseResourceJWTPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`result`	`CreateOnPremiseResourceJWTResult`

saveWorkflowTemplate

None

mutation {
  saveWorkflowTemplate(input: {}) {
    id
  }
}

Input fields (SaveWorkflowTemplateInput!)

Argument	Type	Description
`name`	`String`	The name of the Integration Template. Must be unique.
`description`	`String`	Additional notes about the Integration Template.
`workflow`	`ID`	The ID of the Workflow on which to base the template.
`id`	`ID`	The ID of the WorkflowTemplate to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (SaveWorkflowTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`workflowTemplate`	`WorkflowTemplate`

testFlowTriggerEvent

Tests an IntegrationFlow's trigger event function for the specified event type.

mutation {
  testFlowTriggerEvent(input: {}) {
    id
  }
}

Input fields (TestFlowTriggerEventInput!)

Argument	Type	Description
`eventType`	`String!`	The type of system event to use for testing.
`id`	`ID`	The ID of the IntegrationFlow to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (TestFlowTriggerEventPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testFlowTriggerEventResult`	`TestFlowTriggerEventResult`

testInstanceFlowConfig

Initiates execution of an InstanceFlowConfig for the purposes of testing.

mutation {
  testInstanceFlowConfig(input: {}) {
    id
  }
}

Input fields (TestInstanceFlowConfigInput!)

Argument	Type	Description
`payload`	`String`	The payload to send with the POST request that triggers the InstanceFlowConfig.
`contentType`	`String`	The content type of the payload to send with the POST request that triggers the InstanceFlowConfig.
`headers`	`String`	The headers to send with the POST request that triggers the InstanceFlowConfig.
`id`	`ID`	The ID of the InstanceFlowConfig to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (TestInstanceFlowConfigPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testInstanceFlowConfigResult`	`TestInstanceFlowConfigResult`

testIntegrationEndpointConfig

Initiates an execution for testing the endpoint configuration of the specified Integration.

mutation {
  testIntegrationEndpointConfig(input: {}) {
    id
  }
}

Input fields (TestIntegrationEndpointConfigInput!)

Argument	Type	Description
`payload`	`String`	The payload to send with the POST request to test the endpoint configuration for the Integration.
`contentType`	`String`	The content type of the payload to send with the POST request to test the endpoint configuration for the Integration.
`headers`	`String`	The headers to send with the POST request to test the endpoint configuration for the Integration.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (TestIntegrationEndpointConfigPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testIntegrationEndpointConfigResult`	`TestIntegrationEndpointConfigResult`

testIntegrationFlow

Initiates execution of an IntegrationFlow for the purposes of testing.

mutation {
  testIntegrationFlow(input: {}) {
    id
  }
}

Input fields (TestIntegrationFlowInput!)

Argument	Type	Description
`payload`	`String`	The payload to send with the POST request that triggers the Integration Flow Test Instance.
`contentType`	`String`	The content type of the payload to send with the POST request that triggers the Integration Flow Test Instance.
`headers`	`String`	The headers to send with the POST request that triggers the Integration Flow Test Instance.
`result`	`String`	The result of the test case.
`asynchronous`	`Boolean`	Whether or not to wait for the execution's response.
`id`	`ID`	The ID of the IntegrationFlow to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (TestIntegrationFlowPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testIntegrationFlowResult`	`TestIntegrationFlowResult`

testWebhookEndpoint

Send a test event to a webhook endpoint to verify it's working correctly.

mutation {
  testWebhookEndpoint(input: {}) {
    id
  }
}

Input fields (TestWebhookEndpointInput!)

Argument	Type	Description
`id`	`ID`	The ID of the WebhookEndpoint to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (TestWebhookEndpointPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testWebhookEndpointResult`	`TestWebhookEndpointResult`

updateAlertGroup

Updates the specified AlertGroup object.

mutation {
  updateAlertGroup(input: {}) {
    id
  }
}

Input fields (UpdateAlertGroupInput!)

Argument	Type	Description
`name`	`String`	The name of the AlertGroup
`users`	`[ID]`	The users in the AlertGroup.
`webhooks`	`[ID]`	The AlertWebhooks in the AlertGroup
`id`	`ID`	The ID of the AlertGroup to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateAlertGroupPayload)

Field	Type	Description
`alertGroup`	`AlertGroup`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

updateAlertMonitor

Updates the specified AlertMonitor object.

mutation {
  updateAlertMonitor(input: {}) {
    id
  }
}

Input fields (UpdateAlertMonitorInput!)

Argument	Type	Description
`name`	`String`	The name of the AlertMonitor.
`instance`	`ID`	The Instance that is being monitored by the AlertMonitor.
`flowConfig`	`ID`	The IntegrationFlow that is being monitored by the AlertMonitor.
`logSeverityLevelCondition`	`Int`	The log severity level condition to monitor for relevant AlertTrigger types.
`durationSecondsCondition`	`Int`	The execution duration condition to monitor for relevant AlertTrigger types.
`executionOverdueMinutesCondition`	`Int`	The execution overdue condition to monitor for relevant AlertTrigger types.
`triggers`	`[ID]`	The AlertTriggers that are setup to trigger the AlertMonitor.
`groups`	`[ID]`	The AlertGroups to notify when the AlertMonitor is triggered.
`users`	`[ID]`	The Users to notify when the AlertMonitor is triggered.
`webhooks`	`[ID]`	The AlertWebhooks to call when the AlertMonitor is triggered.
`id`	`ID`	The ID of the AlertMonitor to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateAlertMonitorPayload)

Field	Type	Description
`alertMonitor`	`AlertMonitor`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

updateAlertWebhook

Updates the specified AlertWebhook object.

mutation {
  updateAlertWebhook(input: {}) {
    id
  }
}

Input fields (UpdateAlertWebhookInput!)

Argument	Type	Description
`name`	`String`	The name of the AlertWebhook.
`url`	`String`	The URL of the AlertWebhook.
`payloadTemplate`	`String`	The template that is hydrated and then used as the body of the AlertWebhook request.
`headers`	`String`	A JSON string of key/value pairs that will be sent as headers in the Webhook request.
`id`	`ID`	The ID of the AlertWebhook to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateAlertWebhookPayload)

Field	Type	Description
`alertWebhook`	`AlertWebhook`
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`

updateComponent

Users should not be able to actually update a component, but will use this mutation to update the "starred" status

mutation {
  updateComponent(input: {}) {
    id
  }
}

Input fields (UpdateComponentInput!)

Argument	Type	Description
`starred`	`Boolean`	Indicates whether the record is starred by the signed-in User.
`id`	`ID`	The ID of the Component to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateComponentPayload)

Field	Type	Description
`clientMutationId`	`String`
`component`	`Component`
`errors`	`[ErrorType!]!`

updateConnectionTemplate

Updates the specified ConnectionTemplate object.

mutation {
  updateConnectionTemplate(input: {}) {
    id
  }
}

Input fields (UpdateConnectionTemplateInput!)

Argument	Type	Description
`connection`	`ID`	The Connection from which this template is structured.
`name`	`String`	The name of this template.
`presets`	`[ConnectionTemplateField]`	The input presets associated with this template.
`id`	`ID`	The ID of the ConnectionTemplate to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateConnectionTemplatePayload)

Field	Type	Description
`clientMutationId`	`String`
`connectionTemplate`	`ConnectionTemplate`
`errors`	`[ErrorType!]!`

updateCredential

DEPRECATED.

mutation {
  updateCredential(input: {}) {
    id
  }
}

Input fields (UpdateCredentialInput!)

Argument	Type	Description
`label`	`String`	The name of the Credential.
`values`	`[InputCredentialFieldValue]`	A list of InputCredentialFieldValues that contain the values for the CredentialFields.
`id`	`ID`	The ID of the Credential to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateCredentialPayload)

Field	Type	Description
`clientMutationId`	`String`
`credential`	`Credential`
`errors`	`[ErrorType!]!`

updateCustomer

Updates the specified Customer object.

mutation {
  updateCustomer(input: {}) {
    id
  }
}

Input fields (UpdateCustomerInput!)

Argument	Type	Description
`name`	`String`	The name of the Customer, which must be unique within the scope of its Organization.
`description`	`String`	Additional notes about the Customer.
`allowEmbeddedDesigner`	`Boolean`	Specifies whether this Customer can use the Embedded Designer.
`labels`	`[String]`	The labels that are associated with the object.
`avatarUrl`	`String`	The URL for the avatar image.
`externalId`	`String`	Allows for mapping an external entity to a Prismatic record.
`starred`	`Boolean`	Indicates whether the record is starred by the signed-in User.
`addAttachment`	`AttachmentInput`	Adds the specified Attachment to the object.
`renameAttachment`	`AttachmentRenameInput`	Renames the specified Attachment from the object.
`removeAttachment`	`AttachmentInput`	Removes the specified Attachment on the object.
`id`	`ID`	The ID of the Customer to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateCustomerPayload)

Field	Type	Description
`clientMutationId`	`String`
`customer`	`Customer`
`errors`	`[ErrorType!]!`

updateCustomerConfigVariable

Updates the specified CustomerConfigVariable object.

mutation {
  updateCustomerConfigVariable(input: {}) {
    id
  }
}

Input fields (UpdateCustomerConfigVariableInput!)

Argument	Type	Description
`key`	`String`	The display name of this variable.
`customer`	`ID`	The Customer with which this Config Variable is associated.
`isTest`	`Boolean`	Specifies whether this Config Variable is meant for testing.
`inputs`	`[InputExpression]`	The collection of Expressions that serve as inputs to this variable.
`redeploy`	`Boolean`	Indicates whether to redeploy Instances using this Customer Config Variable.
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateCustomerConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

updateCustomerOAuth2Connection

Update OAuth2 Connection properties for a given Customer Config Variable.

mutation {
  updateCustomerOAuth2Connection(input: {}) {
    id
  }
}

Input fields (UpdateCustomerOAuth2ConnectionInput!)

Argument	Type	Description
`refreshAt`	`DateTime`	The timestamp at which the next refresh attempt will occur for the Connection.
`accessToken`	`String`	The OAuth2 access token to use for the Connection.
`refreshToken`	`String`	The OAuth2 refresh token to use for the Connection.
`tokenType`	`String`	The type of OAuth2 token to use for the Connection.
`expiresIn`	`Int`	The number of seconds until the token is expired and a refresh must occur for the Connection.
`context`	`String`	The context to use for the Connection. Completely replaces any existing value for context on the Connection.
`status`	`String`	The status to use for the Connection.
`additionalTokenFields`	`String`	Additional fields to store on the token.
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateCustomerOAuth2ConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`customerConfigVariable`	`CustomerConfigVariable`
`errors`	`[ErrorType!]!`

updateEmbedded

None

mutation {
  updateEmbedded(input: {}) {
    id
  }
}

Input fields (UpdateEmbeddedInput!)

Argument	Type	Description
`brandedElements`	`String`	Specifies custom names for branded elements.
`requiredComponents`	`[RequiredComponentInput]`	A list of Component identifiers that embedded designers are required to build into Integrations.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateEmbeddedPayload)

Field	Type	Description
`clientMutationId`	`String`
`embedded`	`Embedded`
`errors`	`[ErrorType!]!`

updateExternalLogStream

Updates the specified ExternalLogStream object.

mutation {
  updateExternalLogStream(input: {}) {
    id
  }
}

Input fields (UpdateExternalLogStreamInput!)

Argument	Type	Description
`name`	`String`	Name of the ExternalLogStream.
`url`	`String`	The URL of the ExternalLogStream.
`payloadTemplate`	`String`	The template that is hydrated and then used as the body of the ExternalLogStream request.
`headers`	`String`	A JSON string of key/value pairs that will be sent as headers in the ExternalLogStream request.
`severityLevels`	`[LogSeverityLevelInput]`	The Log severity levels for which Logs should be sent to the ExternalLogStream.
`id`	`ID`	The ID of the ExternalLogStream to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateExternalLogStreamPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`externalLogStream`	`ExternalLogStream`

updateInstance

Updates the specified Instance object.

mutation {
  updateInstance(input: {}) {
    id
  }
}

Input fields (UpdateInstanceInput!)

Argument	Type	Description
`description`	`String`	Additional notes about the Instance.
`name`	`String`	The name of the Instance.
`integration`	`ID`	The Integration that has been deployed for the Instance.
`globalDebug`	`Boolean`	Specifies whether Instance executions should run in debug mode.
`labels`	`[String]`	The labels that are associated with the object.
`configVariables`	`[InputInstanceConfigVariable]`	The Instance with which the Config Variable is associated.
`flowConfigs`	`[InputInstanceFlowConfig]`	The configuration for the IntegrationFlow associated with the Instance.
`preserveDeployState`	`Boolean`	Specifies whether to update the value of needsDeploy as part of the mutation or leave its current value unaltered.
`configMode`	`String`	Desired configuration mode.
`logsDisabled`	`Boolean`	This field is deprecated.
`stepResultsDisabled`	`Boolean`	This field is deprecated.
`enabled`	`Boolean`	Specifies whether the Instance is currently enabled and in an executable state.
`starred`	`Boolean`	Indicates whether the record is starred by the signed-in User.
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateInstancePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

updateInstanceConfigVariables

Update one or more Instance config variables.

mutation {
  updateInstanceConfigVariables(input: {}) {
    id
  }
}

Input fields (UpdateInstanceConfigVariablesInput!)

Argument	Type	Description
`configVariables`	`[InputInstanceConfigVariable]`	The Instance with which the Config Variable is associated.
`configMode`	`String`	Desired configuration mode.
`configComplete`	`Boolean`	Whether the configuration is complete and ready to be deployed.
`id`	`ID`	The ID of the Instance to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateInstanceConfigVariablesPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instance`	`Instance`

updateInstanceProfile

Updates the specified InstanceProfile object.

mutation {
  updateInstanceProfile(input: {}) {
    id
  }
}

Input fields (UpdateInstanceProfileInput!)

Argument	Type	Description
`description`	`String`	Additional notes about the Instance Profile.
`isDefaultProfile`	`Boolean`	Specifies whether this Instance Profile is the default used when no Instance Profile is explicitly specified during Instance creation.
`logsDisabled`	`Boolean`	Specifies whether to disable the creation of logs during Instance execution.
`stepResultsDisabled`	`Boolean`	Specifies whether to disable the creation of step results during Instance execution.
`allocatedMemoryMb`	`Int`	The amount of memory allocated to the Instance Runner Lambda function.
`instanceBillingType`	`String`	The billing type for the Instances that use this Instance Profile.
`quickStart`	`Boolean`	DEPRECATED: Use quick_start_instances instead. Whether instances using this profile will startup faster when triggered.
`quickStartInstances`	`Int`	The number of QuickStart runners reserved for instances using this profile.
`id`	`ID`	The ID of the InstanceProfile to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateInstanceProfilePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceProfile`	`InstanceProfile`

updateInstancesUsingCustomerConfigVariable

Refresh all Instances that refer to the specified Customer Config Variable. This re-computes the Instance's config variables and connection inputs. If the Instances are deployed, it will redeploy them as necessary. This mutation does not update the Instance to the latest Integration version.

mutation {
  updateInstancesUsingCustomerConfigVariable(input: {}) {
    id
  }
}

Input fields (UpdateInstancesUsingCustomerConfigVariableInput!)

Argument	Type	Description
`id`	`ID`	The ID of the CustomerConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateInstancesUsingCustomerConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`result`	`UpdateInstancesUsingCustomerConfigVariableResult`

updateIntegration

Updates the specified Integration object.

mutation {
  updateIntegration(input: {}) {
    id
  }
}

Input fields (UpdateIntegrationInput!)

Argument	Type	Description
`name`	`String`	The name of the Integration.
`description`	`String`	Additional notes about the Integration.
`category`	`String`	Specifies the category of the Integration.
`customer`	`ID`	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
`endpointConfigTestPayload`	`String`	Data payload for testing the endpoint configuration for this Integration.
`endpointConfigTestContentType`	`String`	Content type of the payload for testing the endpoint configuration for this Integration.
`endpointConfigTestHeaders`	`String`	A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
`useAsTemplate`	`Boolean`	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
`templateConfiguration`	`String`	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
`allowMultipleMarketplaceInstances`	`Boolean`	Specifies whether multiple Instances of this Integration may be created from the Marketplace.
`metadata`	`String`	A JSON string that represents metadata for the Integration.
`labels`	`[String]`	The labels that are associated with the object.
`avatarUrl`	`String`	The URL for the avatar image.
`testConfigVariables`	`[InputInstanceConfigVariable]`	Config Variables that have been specified for the purposes of testing the Integration.
`flows`	`[InputIntegrationFlow]`	The Integration of which the IntegrationFlow is a part.
`definition`	`String`	The YAML serialized definition of the Integration to import.
`starred`	`Boolean`	Indicates whether the record is starred by the signed-in User.
`addAttachment`	`AttachmentInput`	Adds the specified Attachment to the object.
`renameAttachment`	`AttachmentRenameInput`	Renames the specified Attachment from the object.
`removeAttachment`	`AttachmentInput`	Removes the specified Attachment on the object.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateIntegrationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

updateIntegrationMarketplaceConfiguration

Updates the configuration of an Integration Version for use in the Integration Marketplace.

mutation {
  updateIntegrationMarketplaceConfiguration(input: {}) {
    id
  }
}

Input fields (UpdateIntegrationMarketplaceConfigurationInput!)

Argument	Type	Description
`overview`	`String`	Specifies an Overview of the Integration to describe its functionality for use in the Integration Marketplace.
`marketplaceConfiguration`	`String`	Specifies whether an Integration will be available in the Integration Marketplace and if the Integration is deployable by a Customer User.
`marketplaceTabConfiguration`	`String`	The Marketplace Tabs available to Customer Users for configuring this Integration.
`allowMultipleMarketplaceInstances`	`Boolean`	Specifies whether multiple Instances of this Integration may be created from the Marketplace.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateIntegrationMarketplaceConfigurationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

updateIntegrationTestConfiguration

Updates the specified Integration object.

mutation {
  updateIntegrationTestConfiguration(input: {}) {
    id
  }
}

Input fields (UpdateIntegrationTestConfigurationInput!)

Argument	Type	Description
`endpointConfigTestPayload`	`String`	Data payload for testing the endpoint configuration for this Integration.
`endpointConfigTestContentType`	`String`	Content type of the payload for testing the endpoint configuration for this Integration.
`endpointConfigTestHeaders`	`String`	A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
`flows`	`[InputIntegrationFlow]`	The Integration of which the IntegrationFlow is a part.
`listeningMode`	`Boolean`	Toggle listening mode for webhook snapshot executions.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateIntegrationTestConfigurationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

updateIntegrationVersionAvailability

Updates the availability of an Integration version.

mutation {
  updateIntegrationVersionAvailability(input: {}) {
    id
  }
}

Input fields (UpdateIntegrationVersionAvailabilityInput!)

Argument	Type	Description
`available`	`Boolean!`	Flag the Integration version as available or not
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateIntegrationVersionAvailabilityPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

updateOAuth2Connection

Update OAuth2 Connection properties for a given Instance Config Variable.

mutation {
  updateOAuth2Connection(input: {}) {
    id
  }
}

Input fields (UpdateOAuth2ConnectionInput!)

Argument	Type	Description
`refreshAt`	`DateTime`	The timestamp at which the next refresh attempt will occur for the Connection.
`accessToken`	`String`	The OAuth2 access token to use for the Connection.
`refreshToken`	`String`	The OAuth2 refresh token to use for the Connection.
`tokenType`	`String`	The type of OAuth2 token to use for the Connection.
`expiresIn`	`Int`	The number of seconds until the token is expired and a refresh must occur for the Connection.
`context`	`String`	The context to use for the Connection. Completely replaces any existing value for context on the Connection.
`status`	`String`	The status to use for the Connection.
`additionalTokenFields`	`String`	Additional fields to store on the token.
`id`	`ID`	The ID of the InstanceConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateOAuth2ConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`instanceConfigVariable`	`InstanceConfigVariable`

updateOrganization

Updates the specified Organization object.

mutation {
  updateOrganization(input: {}) {
    id
  }
}

Input fields (UpdateOrganizationInput!)

Argument	Type	Description
`name`	`String`	The unique name of the Organization.
`featureFlags`	`String`
`brandedElements`	`String`	Specifies custom names for branded elements.
`labels`	`[String]`	The labels that are associated with the object.
`avatarUrl`	`String`	The URL for the avatar image.
`marketplaceName`	`String`	DEPRECATED. Display name of the Organization's Marketplace.
`id`	`ID`	The ID of the Organization to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateOrganizationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`organization`	`Organization`

updateScopedConfigVariable

Updates the specified ScopedConfigVariable object.

mutation {
  updateScopedConfigVariable(input: {}) {
    id
  }
}

Input fields (UpdateScopedConfigVariableInput!)

Argument	Type	Description
`key`	`String`	The display name of this variable.
`description`	`String`	Additional notes about the Scoped Config Variable.
`defaultForComponent`	`Boolean`	Specifies whether this Config Variable is required for Customers using the related Component.
`inputs`	`[InputExpression]`	The collection of Expressions that serve as inputs to this variable.
`oAuthRedirectConfig`	`OAuthRedirectConfigInput`	Configuration for OAuth redirects.
`redeploy`	`Boolean`	Indicates whether to redeploy Instances using Scoped Config Variable.
`unsetOAuthRedirectConfig`	`Boolean`	When true, removes oAuthSuccessRedirectUri and oAuthFailureRedirectUri from meta.
`id`	`ID`	The ID of the ScopedConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateScopedConfigVariablePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

updateScopedOAuth2Connection

Update OAuth2 Connection properties for a given Scoped Config Variable.

mutation {
  updateScopedOAuth2Connection(input: {}) {
    id
  }
}

Input fields (UpdateScopedOAuth2ConnectionInput!)

Argument	Type	Description
`refreshAt`	`DateTime`	The timestamp at which the next refresh attempt will occur for the Connection.
`accessToken`	`String`	The OAuth2 access token to use for the Connection.
`refreshToken`	`String`	The OAuth2 refresh token to use for the Connection.
`tokenType`	`String`	The type of OAuth2 token to use for the Connection.
`expiresIn`	`Int`	The number of seconds until the token is expired and a refresh must occur for the Connection.
`context`	`String`	The context to use for the Connection. Completely replaces any existing value for context on the Connection.
`status`	`String`	The status to use for the Connection.
`additionalTokenFields`	`String`	Additional fields to store on the token.
`id`	`ID`	The ID of the ScopedConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateScopedOAuth2ConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`scopedConfigVariable`	`ScopedConfigVariable`

updateTestCase

Update an existing TestCase.

mutation {
  updateTestCase(input: {}) {
    id
  }
}

Input fields (UpdateTestCaseInput!)

Argument	Type	Description
`name`	`String`	The name of the TestCase.
`contentType`	`String`	Content type of the test payload.
`payload`	`String`	Test step payload data.
`headers`	`String`	Test headers as key/value pairs.
`result`	`String`	Test step result data.
`id`	`ID`	The ID of the TestCase to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateTestCasePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`testCase`	`TestCase`

updateTheme

Updates an Organizations Theme.

mutation {
  updateTheme(input: {}) {
    id
  }
}

Input fields (UpdateThemeInput!)

Argument	Type	Description
`colors`	`[ThemeColorInput]`	A list of inputs that describe the colors used in the theme.
`properties`	`[ThemePropertyInput]`	A list of inputs that describe the properties used in the theme.
`id`	`ID`	The ID of the Theme to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateThemePayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`theme`	`Theme`

updateUser

Updates the specified User object.

mutation {
  updateUser(input: {}) {
    id
  }
}

Input fields (UpdateUserInput!)

Argument	Type	Description
`name`	`String`	The user's preferred name.
`darkMode`	`Boolean`	Designates whether the User has dark mode activated or not.
`darkModeSyncWithOs`	`Boolean`	Designates whether dark mode should be derived from the operating system.
`role`	`ID`	The role to associate with the User.
`phone`	`String`	The preferred contact phone number for the User.
`featureFlags`	`String`
`avatarUrl`	`String`	The URL for the avatar image.
`externalId`	`String`	Allows for mapping an external entity to a Prismatic record.
`id`	`ID`	The ID of the User to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateUserPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`user`	`User`

updateUserLevelOAuth2Connection

Update OAuth2 Connection properties for a given User Level Config Variable.

mutation {
  updateUserLevelOAuth2Connection(input: {}) {
    id
  }
}

Input fields (UpdateUserLevelOAuth2ConnectionInput!)

Argument	Type	Description
`refreshAt`	`DateTime`	The timestamp at which the next refresh attempt will occur for the Connection.
`accessToken`	`String`	The OAuth2 access token to use for the Connection.
`refreshToken`	`String`	The OAuth2 refresh token to use for the Connection.
`tokenType`	`String`	The type of OAuth2 token to use for the Connection.
`expiresIn`	`Int`	The number of seconds until the token is expired and a refresh must occur for the Connection.
`context`	`String`	The context to use for the Connection. Completely replaces any existing value for context on the Connection.
`status`	`String`	The status to use for the Connection.
`additionalTokenFields`	`String`	Additional fields to store on the token.
`id`	`ID`	The ID of the UserLevelConfigVariable to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateUserLevelOAuth2ConnectionPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`userLevelConfigVariable`	`UserLevelConfigVariable`

updateWebhookEndpoint

Updates the specified WebhookEndpoint object.

mutation {
  updateWebhookEndpoint(input: {}) {
    id
  }
}

Input fields (UpdateWebhookEndpointInput!)

Argument	Type	Description
`name`	`String`	Friendly name for the webhook endpoint.
`url`	`String`	The URL where webhook events will be sent.
`description`	`String`	Additional notes about this webhook endpoint configuration.
`secret`	`String`	Secret key used for HMAC signature generation. If provided, all webhook payloads will include an X-Webhook-Signature header.
`headers`	`String`	A JSON object of key/value pairs that will be sent as headers with each webhook request.
`enabled`	`Boolean`	Whether this webhook endpoint is currently enabled. Disabled endpoints will not receive events.
`eventTypes`	`[String]`	List of event types to subscribe to.
`id`	`ID`	The ID of the WebhookEndpoint to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateWebhookEndpointPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`webhookEndpoint`	`WebhookEndpoint`

updateWorkflowTestConfiguration

Updates test configuration for a Workflow.

mutation {
  updateWorkflowTestConfiguration(input: {}) {
    id
  }
}

Input fields (UpdateWorkflowTestConfigurationInput!)

Argument	Type	Description
`listeningMode`	`Boolean`	Toggle listening mode for webhook snapshot executions.
`id`	`ID`	The ID of the Integration to mutate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (UpdateWorkflowTestConfigurationPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`integration`	`Integration`

validateIntegrationSchema

Validate an Integration schema.

mutation {
  validateIntegrationSchema(input: {}) {
    id
  }
}

Input fields (ValidateIntegrationSchemaInput!)

Argument	Type	Description
`definition`	`String!`	The YAML serialized definition of the Integration to validate.
`clientMutationId`	`String`	A unique identifier for the client performing the mutation.

Return fields (ValidateIntegrationSchemaPayload)

Field	Type	Description
`clientMutationId`	`String`
`errors`	`[ErrorType!]!`
`result`	`ValidateIntegrationSchemaFormResult`

administerObjectPermission​

bulkDisableInstancesUsingConnection​

bulkDisableInstancesUsingCustomerConnection​

bulkUpdateInstancesToLatestIntegrationVersion​

changePassword​

clearAlertMonitor​

convertLowCodeIntegration​

createAlertGroup​

createAlertMonitor​

createAlertWebhook​

createConnectionTemplate​

createCustomer​

createCustomerConfigVariable​

createCustomerCredential​

createCustomerUser​

createExternalLogStream​

createInstance​

createInstanceProfile​

createIntegration​

createOnPremiseResourceJWT​

createOrganizationCredential​

createOrganizationSigningKey​

createOrganizationUser​

createScopedConfigVariable​

createTestCase​

createUserLevelConfig​

createWebhookEndpoint​

deleteAlertGroup​

deleteAlertMonitor​

deleteAlertWebhook​

deleteComponent​

deleteConnectionTemplate​

deleteCredential​

deleteCustomer​

deleteCustomerConfigVariable​

deleteExternalLogStream​

deleteInstance​

deleteInstanceProfile​

deleteIntegration​

deleteIntegrationTemplate​

deleteOnPremiseResource​

deleteOrganization​

deleteOrganizationSigningKey​

deleteScopedConfigVariable​

deleteTestCase​

deleteUser​

deleteUserLevelConfig​

deleteWebhookEndpoint​

deleteWorkflow​

deleteWorkflowTemplate​

deployInstance​

disableWorkflow​

disconnectConnection​

disconnectCustomerConnection​

disconnectScopedConnection​

disconnectUserLevelConnection​

enableWorkflow​

fetchConfigWizardPageContent​

fetchDataSourceContent​

forkIntegration​

importIntegration​

importIntegrationTemplate​

importOrganizationSigningKey​

importWorkflow​

publishComponent​

publishIntegration​

publishWorkflow​

replayExecution​

requestOAuth2CredentialAuthorization​

rotateOnPremiseResourceJWT​

saveWorkflowTemplate​

testFlowTriggerEvent​

testInstanceFlowConfig​

testIntegrationEndpointConfig​

testIntegrationFlow​

testWebhookEndpoint​

updateAlertGroup​

updateAlertMonitor​

updateAlertWebhook​

updateComponent​

administerObjectPermission

bulkDisableInstancesUsingConnection

bulkDisableInstancesUsingCustomerConnection

bulkUpdateInstancesToLatestIntegrationVersion

changePassword

clearAlertMonitor

convertLowCodeIntegration

createAlertGroup

createAlertMonitor

createAlertWebhook

createConnectionTemplate

createCustomer

createCustomerConfigVariable

createCustomerCredential

createCustomerUser

createExternalLogStream

createInstance

createInstanceProfile

createIntegration

createOnPremiseResourceJWT

createOrganizationCredential

createOrganizationSigningKey

createOrganizationUser

createScopedConfigVariable

createTestCase

createUserLevelConfig

createWebhookEndpoint

deleteAlertGroup

deleteAlertMonitor

deleteAlertWebhook

deleteComponent

deleteConnectionTemplate

deleteCredential

deleteCustomer

deleteCustomerConfigVariable

deleteExternalLogStream

deleteInstance

deleteInstanceProfile

deleteIntegration

deleteIntegrationTemplate

deleteOnPremiseResource

deleteOrganization

deleteOrganizationSigningKey

deleteScopedConfigVariable

deleteTestCase

deleteUser

deleteUserLevelConfig

deleteWebhookEndpoint

deleteWorkflow

deleteWorkflowTemplate

deployInstance

disableWorkflow

disconnectConnection

disconnectCustomerConnection

disconnectScopedConnection

disconnectUserLevelConnection

enableWorkflow

fetchConfigWizardPageContent

fetchDataSourceContent

forkIntegration

importIntegration

importIntegrationTemplate

importOrganizationSigningKey

importWorkflow

publishComponent

publishIntegration

publishWorkflow

replayExecution

requestOAuth2CredentialAuthorization

rotateOnPremiseResourceJWT

saveWorkflowTemplate

testFlowTriggerEvent

testInstanceFlowConfig

testIntegrationEndpointConfig

testIntegrationFlow

testWebhookEndpoint

updateAlertGroup

updateAlertMonitor

updateAlertWebhook

updateComponent