Skip to main content

createIntegration Mutation

Creates a new Integration object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_integrations]. 2. The signed-in User has any of the following permissions for the access function context object 'customer': [customer_manage_integrations] when a value for 'customer.allow_embedded_designer' is provided in the access function context and equals 'True'.

Input fields (CreateIntegrationInput!)

ArgumentTypeDescription
nameString!The name of the Integration.
descriptionStringAdditional notes about the Integration.
customerIDThe Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
endpointConfigTestPayloadStringData payload for testing the endpoint configuration for this Integration.
endpointConfigTestContentTypeStringContent type of the payload for testing the endpoint configuration for this Integration.
endpointConfigTestHeadersStringA JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
labels[String]The labels that are associated with the object.
definitionStringThe YAML serialized definition of the Integration to import.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (CreateIntegrationPayload)

clientMutationId (String)
errors ([ErrorType!]!)
integration (Integration)