Skip to main content

Prismatic Connector

Prismatic Interact with the Prismatic internal API

Connections

Prismatic Refresh Token

Prismatic Refresh Token

To authenticate with this component, a refresh token obtained from the Prism Command Line Interface (CLI) is required.

For users with multiple tenants in a single region, a Tenant ID can optionally be provided to specify which tenant to authenticate with.

Prerequisites

  • Prism CLI installed, configured and authenticated

Setup Steps

To obtain a refresh token:

  1. Ensure the Prism CLI is authenticated by running:
    prism login
  2. Generate a refresh token by running:
    prism me:token --type refresh
  3. Copy the generated JWT token from the command output

The token will be in JWT format, similar to:

qWu7twYOhI0q2KWtf6LLs80bnN8Hp6K1HhwHW7rlpNiOF

For multi tenant scenarios:

If the organization has multiple tenants in a single region:

  1. Verify available tenants by running:
    prism me
  2. Copy the Tenant ID (UUID format) from the command output
  3. Use this Tenant ID when configuring the connection
Multi Tenant Configuration

If no Tenant ID is provided, the connection will default to the first tenant associated with the region. Only provide a Tenant ID if explicit tenant selection is required for the use case.

Configure the Connection

  • Enter the Refresh Token obtained from the prism me:token --type refresh command
  • Optional: Enter the Tenant ID (UUID format) if authenticating with a specific tenant in a multi tenant setup
InputCommentsDefault
Refresh TokenProvide the Refresh Token obtained from the prism command line by calling prism me:token --type refresh.
Tenant IDIf you have multiple tenants in a single region, you can specify which tenant you want to authenticate with by including the tenant_id (UUID). You can verify your tenant ID by running prism me. If no tenant ID is provided, the first tenant associated with your region will be used by default.

Actions

Deploy Instance

Deploy an instance to production

InputCommentsDefault
Connection
Instance IdProvide the unique ID of an instance.

Disable Instance

Disable an existing instance

InputCommentsDefault
Connection
Instance IdProvide the unique ID of an instance.

Get Current User

Get information about the current logged in user

InputCommentsDefault
Connection

Get Customer

Get a customer's information and metadata

InputCommentsDefault
Connection
CustomerProvide the unique identifier of a customer. This value should be an Id

Get Execution

Get the information and metadata of an execution

InputCommentsDefault
Connection
Execution IdProvide the unique identifier of an execution record.

Get Instance

Get the information and metadata of an existing instance

InputCommentsDefault
Connection
Instance IdProvide the unique ID of an instance.

Get Integration

Get the information and metadata of an integration

InputCommentsDefault
Connection
Integration IdProvide the unique identifier of an integration. This value should be the Id of the integration.

Import Integration

Import Integration

InputCommentsDefault
Connection
Integration IdProvide the unique identifier of an integration. This value should be the Id of the integration.
YAML DefinitionProvide a string value for the definition of the integration.

List Components

Returns a list of all the components published to your account

InputCommentsDefault
Connection

List Customers

List all customers in an organization

InputCommentsDefault
Connection
BeforeSpecifies a cursor for use in combination with last to implement backward pagination.
AfterSpecifies a cursor for use in combination with first to implement forward pagination.
NameProvide a name.
OffsetFilter results based on the offset.
External IdProvide the customer external Id.
Description ContainsFilter for objects where description contains the specified value (case insensitive).
Label ContainsFilter for objects where labels contains the specified value (case insensitive).
LastA non-negative integer that specifies to return at most last edges before the before cursor.
Name ContainsA non-negative integer that specifies to return at most last edges before the before cursor.
Name Starts WithProvide a value for the start of the customer name

List Flows

List all flows on an integration

InputCommentsDefault
Connection
Integration IdProvide the unique identifier of an integration. This value should be the Id of the integration.

List Instances

List all instances

InputCommentsDefault
Connection
NameProvide a name.
BeforeSpecifies a cursor for use in combination with last to implement backward pagination.
AfterSpecifies a cursor for use in combination with first to implement forward pagination.
CustomerProvide the unique identifier of a customer. This value should be an Id
OffsetFilter results based on the offset.
CompatibilityProvide an integer value to filter by compatibility.
Customer External IdProvide the customer external Id.
DescriptionProvide a string value for the description.
Description ContainsFilter for objects where description contains the specified value (case insensitive).
EnabledFilter for objects where description contains the specified value (case insensitive).true
FirstA non-negative integer that specifies to return at most first edges after the after cursor.
IntegrationProvide an identifier for the integration. This value should be an id.
Label ContainsFilter for objects where labels contains the specified value (case insensitive).
LastA non-negative integer that specifies to return at most last edges before the before cursor.
Name ContainsA non-negative integer that specifies to return at most last edges before the before cursor.
Needs DeployFilter for objects where needsDeploy matches the specified value.false

List Integrations

List all available integrations

InputCommentsDefault
Connection
AfterSpecifies a cursor for use in combination with first to implement forward pagination.
BeforeSpecifies a cursor for use in combination with last to implement backward pagination.
NameProvide a name.
OffsetFilter results based on the offset.
All VersionsReturn all versions instead of only the latestfalse
CategoryFilter for objects where category matches the specified value.
Category ContainsFilter for objects where category contains the specified value (case insensitive).
DescriptionProvide a string value for the description.
Description ContainsFilter for objects where description contains the specified value (case insensitive).
FirstA non-negative integer that specifies to return at most first edges after the after cursor.
Has InstancesReturn only Integrations that have Instancesfalse
Has Unpublished ChangesFilter for objects where hasUnpublishedChanges matches the specified value.true
Label ContainsFilter for objects where labels contains the specified value (case insensitive).
LastA non-negative integer that specifies to return at most last edges before the before cursor.
MarketplaceReturns only the version of Integrations either deployed or available in the Marketplacefalse
Marketplace ConfigReturn only integrations sharing the provided marketplace config
Name ContainsA non-negative integer that specifies to return at most last edges before the before cursor.
Version Is AvailableFilter for objects where versionIsAvailable matches the specified value.true
Version NumberProvide an integer value to filter by version number.
Version Sequence IdReturn only integrations sharing the provided version sequence id.

Publish Integration Version

Publish a new version of an existing integration

InputCommentsDefault
Connection
Integration IdProvide the unique identifier of an integration. This value should be the Id of the integration.
CommentsProvide a string value for comments.

Raw GraphQL Request

Send raw GraphQL request to Prismatic

InputCommentsDefault
Connection
Query or MutationProvide a query or mutation for the GraphQL requestquery ($myCustomerId: ID!) {
customer(id: $myCustomerId) {
id
name
externalId
}
}
GraphQL VariablesThese should match the variables of your query or mutation.

Test Flow

Test an existing integration flow

InputCommentsDefault
Connection
Flow IdProvide the unique identifier of a flow
PayloadProvide a payload to be passed to the given flow upon execution.
Content TypeProvide a content type to be passed to the given flow upon execution.

Update Instance

Update an existing instance

InputCommentsDefault
Connection
Instance IdProvide the unique ID of an instance.
NameProvide a string value for the name of the instance
DescriptionProvide a string value for the description of the instance

Update Integration

Update the information and metadata of an integration

InputCommentsDefault
Connection
Integration IdProvide the unique identifier of an integration. This value should be the Id of the integration.
NameProvide a name.
DescriptionProvide a string value for the description.