IntegrationInstance Object

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.

Root Connection

All IntegrationInstance objects of an account are accessible by a query on the root connection integrationInstances. Such a query will return a IntegrationInstanceConnection!, which contains the IntegrationInstance objects in its nodes field.

integrationInstances (IntegrationInstanceConnection!)

Root connection for retrieving IntegrationInstance records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter IntegrationInstanceFilter

Filter to determine which IntegrationInstance records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [IntegrationInstanceOrder!]

Order of the IntegrationInstance records returned.

view IntegrationInstanceView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying IntegrationInstance records.

account (Account)

The account this record belongs to.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

customFields ([CustomField!])

Values of custom fields.

customerAccount (Account)

Account this integration instance is for.

customerRepresentative (Person)

Contact person of customer regarding this integration.

disabled (Boolean)

Whether the integration is currently enabled for this customer.

enabledByCustomer (Boolean)

Whether the customer has enabled this integration.

id (ID!)

Unique identifier of the object.

integration (Integration)

Integration (version) this instance is at.

suspended (Boolean)

Whether the integration is currently suspended for this customer.

suspensionComment (String)

Extra information why the integration is currently suspended for this customer.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

webhook (Webhook)

Webhook of this integration.

webhookPolicy (WebhookPolicy)

The current policy used for the instance's webhook.

Connections

The connection fields in this section allow (paged) access to objects related to a specific IntegrationInstance record. The actual objects will be in the nodes field of the connection.

automationRules (AutomationRuleConnection)

Automation rules of this instance.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

customFieldsAttachments (AttachmentConnection)

Inline images linked to one of the custom fields.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

IntegrationInstance implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a IntegrationInstance.