Skip to main content

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.

Prismatic Connections#

Prismatic Refresh Token#

InputNotes
Input
Refresh Token
string
/ Required
Notes
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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Instance Id
string
/ Required
Notes
Provide the unique identifier of an instance. This value can either be the Id or the name of the instance.
Example
Shopify Instance

Disable Instance#

Disable an existing instance | key: disableInstnce

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Instance Id
string
/ Required
Notes
Provide the unique identifier of an instance. This value can either be the Id or the name of the instance.
Example
Shopify Instance

Get Current User#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

Get Customer#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Customer
string
/ Required
Notes
Provide the unique identifier of a customer. This value can either be an Id or a name
Example
Progix

Get Execution#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Execution Id
string
Notes
Provide the unique identifier of an execution record.
Example
SW50ZWdyYXRpb246Y2ZmNGUgUm2S3nMTUzLWEwMjQtZGI4YzlmOTAzNjIy

Get Instance#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Instance Id
string
/ Required
Notes
Provide the unique identifier of an instance. This value can either be the Id or the name of the instance.
Example
Shopify Instance

Get Integration#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Integration Id
string
/ Required
Notes
Provide the unique identifier of an integration. This value can either be the Id or the name of the integration.
Example
Shopify

Import Integration#

Import Integration | key: importIntegration

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
YAML Definition
string
Notes
Provide a string value for the definition of the integration.
Example
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
Input
Integration Id
string
/ Required
Notes
Provide the unique identifier of an integration. This value can either be the Id or the name of the integration.
Example
Shopify

List Components#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

List Customers#

List all customers in an organization | key: listCustomers

InputNotesExample
Input
After
string
Notes
Filter results to integrations created after a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
Before
string
Notes
Filter results to integrations created before a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Description Contains
string
Notes
Filter for objects where description contains the specified value (case insensitive).
Example
Search for this string
Input
External Id
string
Notes
Provide the customer external Id.
Example
WdyYXRpb246Y33nmNGUgUm2S3nMTUzLWEwMjQtZGI4YzlmOTAzNjIy
Input
Label Contains
string
Notes
Filter for objects where labels contains the specified value (case insensitive).
Example
Search for this string
Input
Last
string
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
1
Input
Name
string
Notes
Provide a name for the integration.
Example
Example Integration
Input
Name Contains
string
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
Search for this string
Input
Name Starts With
string
Notes
Provide a value for the start of the customer name
Example
Search for this string
Input
Offset
string
Notes
Filter results based on the offset for the integration.
Example
2

List Flows#

List all flows on an integration | key: listFlows

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Integration Id
string
/ Required
Notes
Provide the unique identifier of an integration. This value can either be the Id or the name of the integration.
Example
Shopify

List Instances#

List all instances | key: listInstances

InputDefaultNotesExample
Input
After
string
Default
Notes
Filter results to integrations created after a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
Before
string
Default
Notes
Filter results to integrations created before a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
Compatibility
string
Default
Notes
Provide an integer value to filter by compatibility.
Example
1
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Customer External Id
string
Default
Notes
Provide the customer external Id.
Example
12345
Input
Customer
string
Default
Notes
Provide the unique identifier of a customer. This value can either be an Id or a name
Example
Progix
Input
Description
string
Default
Notes
Provide a string value for the description of the integration.
Example
This is an example description
Input
Description Contains
string
Default
Notes
Filter for objects where description contains the specified value (case insensitive).
Example
Search for this string
Input
Enabled
boolean
Default
true
Notes
Filter for objects where description contains the specified value (case insensitive).
Example
 
Input
First
string
Default
Notes
A non-negative integer that specifies to return at most first edges after the after cursor.
Example
1
Input
Integration
string
Default
Notes
Provide an identifier for the integration. This value can either be a name, or id.
Example
Shopify
Input
Label Contains
string
Default
Notes
Filter for objects where labels contains the specified value (case insensitive).
Example
Search for this string
Input
Last
string
Default
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
1
Input
Name
string
Default
Notes
Provide a name for the integration.
Example
Example Integration
Input
Name Contains
string
Default
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
Search for this string
Input
Needs Deploy
boolean
Default
false
Notes
Filter for objects where needsDeploy matches the specified value.
Example
 
Input
Offset
string
Default
Notes
Filter results based on the offset for the integration.
Example
2

Output Example Payload#

{  "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

InputDefaultNotesExample
Input
After
string
Default
Notes
Filter results to integrations created after a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
All Versions
boolean
Default
false
Notes
Return all versions instead of only the latest
Example
 
Input
Before
string
Default
Notes
Filter results to integrations created before a certain date
Example
2022-02-28T20:52:49.763944+00:00
Input
Category
string
Default
Notes
Filter for objects where category matches the specified value.
Example
Example Category
Input
Category Contains
string
Default
Notes
Filter for objects where category contains the specified value (case insensitive).
Example
Search for this string
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Description
string
Default
Notes
Provide a string value for the description of the integration.
Example
This is an example description
Input
Description Contains
string
Default
Notes
Filter for objects where description contains the specified value (case insensitive).
Example
Search for this string
Input
First
string
Default
Notes
A non-negative integer that specifies to return at most first edges after the after cursor.
Example
1
Input
Has Instances
boolean
Default
false
Notes
Return only Integrations that have Instances
Example
 
Input
Has Unpublished Changes
boolean
Default
true
Notes
Filter for objects where hasUnpublishedChanges matches the specified value.
Example
 
Input
Label Contains
string
Default
Notes
Filter for objects where labels contains the specified value (case insensitive).
Example
Search for this string
Input
Last
string
Default
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
1
Input
Marketplace
boolean
Default
false
Notes
Returns only the version of Integrations either deployed or available in the Marketplace
Example
 
Input
Marketplace Config
string
Default
Notes
Return only integrations sharing the provided marketplace config
Example
 
Input
Name
string
Default
Notes
Provide a name for the integration.
Example
Example Integration
Input
Name Contains
string
Default
Notes
A non-negative integer that specifies to return at most last edges before the before cursor.
Example
Search for this string
Input
Offset
string
Default
Notes
Filter results based on the offset for the integration.
Example
2
Input
Version Is Available
boolean
Default
true
Notes
Filter for objects where versionIsAvailable matches the specified value.
Example
 
Input
Version Number
string
Default
Notes
Provide an integer value to filter by version number.
Example
29
Input
Version Sequence Id
string
Default
Notes
Return only integrations sharing the provided version sequence id.
Example
4203516a-15a6-4306-8068-6b5c37a83f51

Output Example Payload#

{  "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

InputNotesExample
Input
Comments
string
Notes
Provide a string value for comments.
Example
This is my comment.
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Integration Id
string
/ Required
Notes
Provide the unique identifier of an integration. This value can either be the Id or the name of the integration.
Example
Shopify

Raw Request#

Issue a raw HTTP request with the configured connection | key: rawRequest

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Query
string
/ Required
Notes
Provide a query or mutation for the GraphQL request
Example
query { components { nodes { label description key } } }

Test Flow#

Test an existing integration flow | key: testFlow

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

Update Instance#

Update an existing instance | key: updateInstance

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Description
string
/ Required
Notes
Provide a string value for the description of the instance
Example
This is an example description
Input
Instance Id
string
/ Required
Notes
Provide the unique identifier of an instance. This value can either be the Id or the name of the instance.
Example
Shopify Instance
Input
Name
string
/ Required
Notes
Provide a string value for the name of the instance
Example
Example Integration

Update Integration#

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

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Description
string
/ Required
Notes
Provide a string value for the description of the integration.
Example
This is an example description
Input
Integration Id
string
/ Required
Notes
Provide the unique identifier of an integration. This value can either be the Id or the name of the integration.
Example
Shopify
Input
Name
string
/ Required
Notes
Provide a name for the integration.
Example
Example Integration