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

To start using the Prismatic component you need to use your authenticated prism client to call the prism me:token --type refresh command. Running this command will give you a refresh token, which you can use to make requests to the Prismatic API.

Now that you have your token, create a new Prismatic connection and enter the token you received from the Prism CLI.

Input	Notes
Refresh Token string / Required apiKey	Provide the Refresh Token obtained from the prism command line by calling prism me:token --type refresh.

Actions

Deploy Instance

Deploy an instance to production | key: deployInstance

Input	Notes	Example
Connection connection / Required connection
Instance Id string / Required instanceId	Provide the unique ID of an instance.	Shopify Instance

Disable Instance

Disable an existing instance | key: disableInstnce

Input	Notes	Example
Connection connection / Required connection
Instance Id string / Required instanceId	Provide the unique ID of an instance.	Shopify Instance

Get Current User

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

Input	Notes
Connection connection / Required connection

Get Customer

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

Input	Notes
Connection connection / Required connection
Customer string / Required customerId	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 connection / Required connection
Execution Id string executionId	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 connection / Required connection
Instance Id string / Required instanceId	Provide the unique ID of an instance.	Shopify Instance

Get Integration

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

Input	Notes
Connection connection / Required connection
Integration Id string / Required integrationId	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 connection / Required connection
YAML Definition string 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 string / Required integrationId	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
Connection connection / Required connection

List Customers

List all customers in an organization | key: listCustomers

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

List Flows

List all flows on an integration | key: listFlows

Input	Notes
Connection connection / Required connection
Integration Id string / Required integrationId	Provide the unique identifier of an integration. This value should be the Id of the integration.

List Instances

List all instances | key: listInstances

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

Example Payload for List Instances

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

Example Payload for List Integrations

{
  "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 string comments	Provide a string value for comments.	This is my comment.
Connection connection / Required connection
Integration Id string / Required integrationId	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	Default	Notes
Connection connection / Required connection
Query or Mutation code / Required query		Provide a query or mutation for the GraphQL request
GraphQL Variables string Key Value List variables		These should match the variables of your query or mutation.

Test Flow

Test an existing integration flow | key: testFlow

Input	Notes	Example
Connection connection / Required connection
Content Type string contentType	Provide a content type to be passed to the given flow upon execution.	application/json
Flow Id string / Required flowId	Provide the unique identifier of a flow	SW50ZWdyYXRpb25GbG93OmEezxyb2ZjItNGNmOS1iNGQ2LWYyanYzViMTE4ZmMwZA==
Payload string 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 connection / Required connection
Description string / Required description	Provide a string value for the description of the instance
Instance Id string / Required instanceId	Provide the unique ID of an instance.	Shopify Instance
Name string / Required 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
Connection connection / Required connection
Description string / Required description	Provide a string value for the description.
Integration Id string / Required integrationId	Provide the unique identifier of an integration. This value should be the Id of the integration.
Name string / Required name	Provide a name.

Interact with the Prismatic internal API

Description​

API Documentation​

Connections​

Prismatic Refresh Token​

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​