Integration

Represents the collection of information that defines an integration, to include the sequence of Component Actions, or steps, inputs, the trigger, and other associated data.

Return fields#

id (ID!)#

The ID of the object.

createdAt (DateTime!)#

The timestamp at which the object was created.

labels ([String!])#

The labels that are associated with the object.

name (String!)#

The name of the Integration.

description (String!)#

Additional notes about the Integration.

parent (Integration)#

Parent Integration this Integration was forked from, if any

stepPlan (SafeJSONString!)#

The hierarchical structure that defines the execution plan for the steps in an Integration.

isSynchronous (Boolean!)#

Specifies whether responses to Executions of this Integration are synchronous. Responses are asynchronous by default.

retryMaxAttempts (Int!)#

Specifies the maximum number of retry attempts that will be performed for Executions of this Integration.

retryDelayMinutes (Int!)#

Specifies the delay in minutes between retry attempts of Executions of this Integration.

retryUsesExponentialBackoff (Boolean!)#

Specifies whether to use exponential backoff to in scheduling retries of Executions of this Integration.

retryUniqueRequestIdField (Expression)#

Specifies a reference to the data to use as a Unique Request ID for retry request cancelation.

hasUnpublishedChanges (Boolean!)#

Specifies whether the Integration definition has changes that have not yet been published.

instances (InstanceConnection!)#

The Integration that has been deployed for the Instance.

actions (IntegrationActionConnection!)#

The Integration of which the IntegrationAction is a part.

attachments ([Attachment])#

A JSON list of objects where each object has a key for name and URL that together describe the Attachment.

trigger (IntegrationAction!)#

The IntegrationAction that is the trigger for the Integration.

versions (VersionConnection!)#

The Versions of the Integration that are available.

testUrl (String!)#

The URL of the endpoint that triggers execution of the Integration Test Runner.

testCredentials (InstanceCredentialConnection!)#

This field has been deprecated and replaced by testConfigVariables.

testConfigVariables (InstanceConfigVariableConnection!)#

Config Variables that are used for testing during Integration design.

testExecutionResults (InstanceExecutionResultConnection!)#

The Execution Results that were generated during testing.

lastExecutedAt (DateTime)#

The timestamp at which the Integration was most recently executed as part of an Instance.

allowPublish (Boolean!)#

Specifies whether the signed-in User can publish the Integration.

allowFork (Boolean!)#

Specifies whether the signed-in User can fork the Integration.

definition (String)#

The YAML that is the declarative definition for the Integration. Suitable for using to re-import the Integration.

requiredConfigVariables (RequiredConfigVariableConnection!)#

Returns a Relay Connection to a collection of Required Config Variable objects.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the Integration.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the Integration.

starred (Boolean)#

Indicates whether the record is starred by the signed-in User.