Prismatic Component

Interact with the Prismatic internal API

Component key: prismatic

Description

This component allows you to communicate with Prismatic's GraphQL API. You can interact with your integrations, instances, flows, and more.

API Documentation

Please see the following guide for more information: Intro to Prismatic's GraphQL API

Connections

Prismatic Refresh Token

key: apiKey

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:

Ensure the Prism CLI is authenticated by running:
```
prism login
```
Generate a refresh token by running:
```
prism me:token --type refresh
```
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:

Verify available tenants by running:
```
prism me
```
Copy the Tenant ID (UUID format) from the command output
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

Input	Notes	Example
Refresh Token	Provide the Refresh Token obtained from the prism command line by calling prism me:token --type refresh.	qWu7twYOhI0q2KWtf6LLs80bnN8Hp6K1HhwHW7rlpNiOF
Tenant ID	If 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.	12345678-1234-1234-1234-123456789abc

Actions

Deploy Instance

Deploy an instance to production | key: deployInstance

Input	Notes	Example
Connection
Instance Id	Provide the unique ID of an instance.	Shopify Instance

Disable Instance

Disable an existing instance | key: disableInstnce

Input	Notes	Example
Connection
Instance Id	Provide the unique ID of an instance.	Shopify Instance

Get Current User

Get information about the current logged in user | key: getCurrentUser

Input	Notes	Example
Connection

Get Customer

Get a customer's information and metadata | key: getCustomer

Input	Notes	Example
Connection
Customer	Provide the unique identifier of a customer. This value should be an Id

Get Execution

Get the information and metadata of an execution | key: getExecution

Input	Notes	Example
Connection
Execution Id	Provide the unique identifier of an execution record.	SW50ZWdyYXRpb246Y2ZmNGUgUm2S3nMTUzLWEwMjQtZGI4YzlmOTAzNjIy

Get Instance

Get the information and metadata of an existing instance | key: getInstance

Input	Notes	Example
Connection
Instance Id	Provide the unique ID of an instance.	Shopify Instance

Get Integration

Get the information and metadata of an integration | key: getIntegration

Input	Notes	Example
Connection
Integration Id	Provide the unique identifier of an integration. This value should be the Id of the integration.

Import Integration

Import Integration | key: importIntegration

Input	Notes	Example
Connection
YAML Definition	Provide a string value for the definition of the integration.	category: '' definitionVersion: 6 description: '' documentation: '' endpointType: flow_specific flows: - description: '' isSynchronous: false name: Flow 1 steps: - action: component: isPublic: true key: webhook-triggers version: 7 key: webhook description: '' inputs: body: type: value value: '' contentType: type: value value: '' statusCode: type: value value: '' isTrigger: true name: Integration Trigger name: prism requiredConfigVars: - connection: component: isPublic: true key: prismatic version: 53 key: apiKey dataType: connection inputs: apiKey: type: value value: >- exampleAPIKey key: prismatic Connection orgOnly: false
Integration Id	Provide the unique identifier of an integration. This value should be the Id of the integration.

List Components

Returns a list of all the components published to your account | key: listComponents

Input	Notes	Example
Connection

List Customers

List all customers in an organization | key: listCustomers

Input	Notes	Example
After	Specifies a cursor for use in combination with first to implement forward pagination.	YXJyYXljb25uZWN0aW9uOjk5
Before	Specifies a cursor for use in combination with last to implement backward pagination.	YXJyYXljb25uZWN0aW9uOjk5
Connection
Description Contains	Filter for objects where description contains the specified value (case insensitive).	Search for this string
External Id	Provide the customer external Id.	WdyYXRpb246Y33nmNGUgUm2S3nMTUzLWEwMjQtZGI4YzlmOTAzNjIy
Label Contains	Filter for objects where labels contains the specified value (case insensitive).	Search for this string
Last	A non-negative integer that specifies to return at most last edges before the before cursor.	1
Name	Provide a name.
Name Contains	A non-negative integer that specifies to return at most last edges before the before cursor.	Search for this string
Name Starts With	Provide a value for the start of the customer name	Search for this string
Offset	Filter results based on the offset.	2

List Flows

List all flows on an integration | key: listFlows

Input	Notes	Example
Connection
Integration Id	Provide the unique identifier of an integration. This value should be the Id of the integration.

List Instances

List all instances | key: listInstances

Input	Notes	Example
After	Specifies a cursor for use in combination with first to implement forward pagination.	YXJyYXljb25uZWN0aW9uOjk5
Before	Specifies a cursor for use in combination with last to implement backward pagination.	YXJyYXljb25uZWN0aW9uOjk5
Compatibility	Provide an integer value to filter by compatibility.	1
Connection
Customer External Id	Provide the customer external Id.	12345
Customer	Provide the unique identifier of a customer. This value should be an Id
Description	Provide a string value for the description.
Description Contains	Filter for objects where description contains the specified value (case insensitive).	Search for this string
Enabled	Filter for objects where description contains the specified value (case insensitive).	true
First	A non-negative integer that specifies to return at most first edges after the after cursor.	1
Integration	Provide an identifier for the integration. This value should be an id.
Label Contains	Filter for objects where labels contains the specified value (case insensitive).	Search for this string
Last	A non-negative integer that specifies to return at most last edges before the before cursor.	1
Name	Provide a name.
Name Contains	A non-negative integer that specifies to return at most last edges before the before cursor.	Search for this string
Needs Deploy	Filter for objects where needsDeploy matches the specified value.	false
Offset	Filter results based on the offset.	2

{
  "data": {
    "status": 200,
    "data": {
      "instances": {
        "pageInfo": {
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "example",
          "endCursor": "example"
        },
        "nodes": [
          {
            "id": "example",
            "updatedAt": "2022-02-28T21:04:42.282103+00:00",
            "labels": [
              "Example Labels"
            ],
            "name": "Test Instance",
            "customer": {
              "id": "example"
            }
          }
        ]
      }
    }
  }
}

List Integrations

List all available integrations | key: listIntegrations

Input	Notes	Example
After	Specifies a cursor for use in combination with first to implement forward pagination.	YXJyYXljb25uZWN0aW9uOjk5
All Versions	Return all versions instead of only the latest	false
Before	Specifies a cursor for use in combination with last to implement backward pagination.	YXJyYXljb25uZWN0aW9uOjk5
Category	Filter for objects where category matches the specified value.	Example Category
Category Contains	Filter for objects where category contains the specified value (case insensitive).	Search for this string
Connection
Description	Provide a string value for the description.
Description Contains	Filter for objects where description contains the specified value (case insensitive).	Search for this string
First	A non-negative integer that specifies to return at most first edges after the after cursor.	1
Has Instances	Return only Integrations that have Instances	false
Has Unpublished Changes	Filter for objects where hasUnpublishedChanges matches the specified value.	true
Label Contains	Filter for objects where labels contains the specified value (case insensitive).	Search for this string
Last	A non-negative integer that specifies to return at most last edges before the before cursor.	1
Marketplace	Returns only the version of Integrations either deployed or available in the Marketplace	false
Marketplace Config	Return only integrations sharing the provided marketplace config
Name	Provide a name.
Name Contains	A non-negative integer that specifies to return at most last edges before the before cursor.	Search for this string
Offset	Filter results based on the offset.	2
Version Is Available	Filter for objects where versionIsAvailable matches the specified value.	true
Version Number	Provide an integer value to filter by version number.	29
Version Sequence Id	Return only integrations sharing the provided version sequence id.	4203516a-15a6-4306-8068-6b5c37a83f51

{
  "data": {
    "status": 200,
    "data": {
      "integrations": {
        "nodes": [
          {
            "id": "example3843985702395",
            "labels": [
              "Example Labels"
            ],
            "avatarUrl": "",
            "name": "example",
            "createdAt": "2022-02-28T20:52:49.763944+00:00",
            "category": null,
            "allowRemove": true,
            "actions": {
              "nodes": [
                {
                  "id": "r80837409928349uf2309f3"
                }
              ]
            },
            "flows": {
              "edges": [
                {
                  "node": {
                    "id": "28y9483f893dwe"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Publish Integration Version

Publish a new version of an existing integration | key: publishIntegration

Input	Notes	Example
Comments	Provide a string value for comments.	This is my comment.
Connection
Integration Id	Provide the unique identifier of an integration. This value should be the Id of the integration.

Raw GraphQL Request

Send raw GraphQL request to Prismatic | key: rawRequest

Input	Notes	Example
Connection
Query or Mutation	Provide a query or mutation for the GraphQL request
GraphQL Variables	These should match the variables of your query or mutation.

Test Flow

Test an existing integration flow | key: testFlow

Input	Notes	Example
Connection
Content Type	Provide a content type to be passed to the given flow upon execution.	application/json
Flow Id	Provide the unique identifier of a flow	SW50ZWdyYXRpb25GbG93OmEezxyb2ZjItNGNmOS1iNGQ2LWYyanYzViMTE4ZmMwZA==
Payload	Provide a payload to be passed to the given flow upon execution.	'{}'

Update Instance

Update an existing instance | key: updateInstance

Input	Notes	Example
Connection
Description	Provide a string value for the description of the instance
Instance Id	Provide the unique ID of an instance.	Shopify Instance
Name	Provide a string value for the name of the instance

Update Integration

Update the information and metadata of an integration | key: updateIntegration

Input	Notes	Example
Connection
Description	Provide a string value for the description.
Integration Id	Provide the unique identifier of an integration. This value should be the Id of the integration.
Name	Provide a name.

Changelog

2026-01-09

Added a Tenant ID input to the Prismatic Refresh Token connection to support multi tenant authentication, allowing users with multiple tenants in a single region to specify which tenant to authenticate with using a UUID that can be verified by running prism me.

2025-10-08

Added global variable support for enhanced token management and authentication persistence

Interact with the Prismatic internal API

Description​

API Documentation​

Connections​

Prismatic Refresh Token​

Prerequisites​

Setup Steps​

Configure the Connection​

Actions​

Deploy Instance​

Disable Instance​

Get Current User​

Get Customer​

Get Execution​

Get Instance​

Get Integration​

Import Integration​

List Components​

List Customers​

List Flows​

List Instances​

List Integrations​

Publish Integration Version​

Raw GraphQL Request​

Test Flow​

Update Instance​

Update Integration​

Changelog​

2026-01-09​

2025-10-08​