Prismatic

https://prismatic.io/docs
Admin
Prismatic is an integration platform that enables users to build, deploy, and manage integrations...
Tokens:2,356,059
Snippets:18,287
Trust Score:9.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize and Install Integration Project

Source: https://prismatic.io/docs/llms-full.txt

CLI commands to scaffold a new integration project and install necessary dependencies.

```bash
prism integrations:init todo-slack-notifications
```

```bash
npm install
```

--------------------------------

### Install gql library

Source: https://prismatic.io/docs/api/get-started/querying-with-python

Install the gql GraphQL client library with requests support.

```bash
pip install gql[requests]
```

--------------------------------

### Initialize and install connector project

Source: https://prismatic.io/docs/llms-full.txt

Commands to scaffold a new connector project and install necessary dependencies.

```bash
prism components:init my-first-connector
```

```bash
npm install
```

--------------------------------

### Install WSL2 on Windows

Source: https://prismatic.io/docs/llms-full.txt

Run this command in PowerShell to initiate the installation of Windows Subsystem for Linux.

```text
wsl --install
```

--------------------------------

### Atlassian Connection Input Examples

Source: https://prismatic.io/docs/llms-full.txt

Example values for Atlassian site identification and authorization URL parameters.

```text
your-company.atlassian.net
```

```text
https://auth.atlassian.com/authorize?audience=api.atlassian.com&prompt=consent
```

--------------------------------

### Generic Pipeline Configuration Examples

Source: https://prismatic.io/docs/llms-full.txt

Example values for various configuration fields used when setting up a generic pipeline.

```json
{"exampleKey": "Example Data"}
```

```javascript
[{key: "example.txt", value: "My File Contents"}]
```

```javascript
[{"key": "Example Key", "value": new Buffer("Hello World")}]
```

```text
User-Agent: curl/7.64.1
```

```text
0
```

```text
json
```

```text
false
```

```text
0
```

```text
2000
```

```text
/sobjects/Account
```

```text
false
```

--------------------------------

### Start on-prem agent Docker container

Source: https://prismatic.io/docs/llms-full.txt

Launch the agent container using environment variables for configuration.

```bash
export REGISTRATION_JWT=$(prism on-prem-resources:registration-jwt --customerId Q3VzdG9tZXI6YjBmZDAyZTItYmE1OC00NzE0LWJhYzgtMDMwNWM5N2JiY2Vj)

docker run \
  --env PRISMATIC_URL=https://app.prismatic.io \
  --env APP_PORT=1433 \
  --env APP_HOST=host.docker.internal \
  --env "NAME=Acme MS SQL" \
  --env REGISTRATION_JWT \
  -t prismaticio/on-prem-agent:latest
```

--------------------------------

### List Webinars Input Examples

Source: https://prismatic.io/docs/llms-full.txt

Examples of OData query parameters and configuration values for the listWebinars action.

```text
teamsAppDefinition
```

```text
startswith(givenName,'J')
```

```text
displayName desc
```

```text
Search For This
```

```text
givenName,surname
```

```text
3
```

```text
30000
```

```text
20
```

--------------------------------

### Install Project Dependencies

Source: https://prismatic.io/docs/get-started/build-integrations/first-integration-code-native

Install the necessary Node.js dependencies for the project.

```bash
npm install
```

--------------------------------

### Install the Prismatic CLI

Source: https://prismatic.io/docs/custom-connectors/get-started/setup

Installs the Prismatic CLI tool globally using npm.

```bash
npm install --global @prismatic-io/prism
```

--------------------------------

### Install HubSpot CLI

Source: https://prismatic.io/docs/components/hubspot

Install the HubSpot CLI globally using npm.

```bash
npm install -g @hubspot/cli
```

--------------------------------

### URL Path Example

Source: https://prismatic.io/docs/components/ukg-pro

Example of a relative URL path for the UKG Pro endpoint.

```text
/personnel/v1/employee-changes
```

--------------------------------

### Install Docker Compose in WSL2

Source: https://prismatic.io/docs/llms-full.txt

Install the docker-compose utility using the apt package manager.

```text
apt install docker-compose
```

--------------------------------

### selectInstalledEquipment

Source: https://prismatic.io/docs/components/servicetitan

Select an Installed Equipment from a dropdown menu (up to 10,000 Installed Equipments).

```APIDOC
## selectInstalledEquipment

### Description
Select an Installed Equipment from a dropdown menu (up to 10,000 Installed Equipments).

### Parameters
- **Connection** (string) - Required
```

--------------------------------

### Get Purchase Receipt Response JSON

Source: https://prismatic.io/docs/example-payloads/ms-business-central/actions/getPurchaseReceipt.json

Example of the JSON object returned by the Get Purchase Receipt action.

```json
{
  "data": {
    "id": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number": "108001",
    "invoiceDate": "2019-01-01T00:00:00.000Z",
    "postingDate": "2019-01-01T00:00:00.000Z",
    "dueDate": "2019-01-01T00:00:00.000Z",
    "vendorNumber": "20000",
    "vendorName": "First Up Consultants",
    "payToName": "First Up Consultants",
    "payToContact": "Evan McIntosh",
    "payToVendorNumber": "20000",
    "shipToName": "First Up Consultants",
    "shipToContact": "Evan McIntosh",
    "buyFromAddressLine1": "100 Day Drive",
    "buyFromAddressLine2": "",
    "buyFromCity": "Chicago",
    "buyFromCountry": "US",
    "buyFromState": "IL",
    "buyFromPostCode": "61236",
    "shipToAddressLine1": "100 Day Drive",
    "shipToAddressLine2": "",
    "shipToCity": "Chicago",
    "shipToCountry": "US",
    "shipToState": "IL",
    "shipToPostCode": "61236",
    "payToAddressLine1": "100 Day Drive",
    "payToAddressLine2": "",
    "payToCity": "Chicago",
    "payToCountry": "US",
    "payToState": "IL",
    "payToPostCode": "61236",
    "currencyCode": "USD",
    "lastModifiedDateTime": "2019-01-01T00:00:00.000Z"
  }
}
```

--------------------------------

### Install dependencies and format code

Source: https://prismatic.io/docs/integrations/code-native/get-started/convert-low-code-code-native

Navigate to the project directory and prepare the environment by installing dependencies and running the formatter.

```bash
cd path-to-unzipped-integration
npm install
npm update --save
npm run format
```

--------------------------------

### Start Shopify Development Server

Source: https://prismatic.io/docs/components/shopify

Navigate to the project directory and launch the development server.

```bash
cd my-new-app
shopify app dev
```

--------------------------------

### UKG Pro Get Single Location JSON Response

Source: https://prismatic.io/docs/example-payloads/ukg-pro/actions/getSingleLocation.json

Example of the JSON payload returned by the Get Single Location action.

```json
{
  "data": {
    "locationCode": "ALBUQ",
    "description": "Albuquerque, NM",
    "isActive": true,
    "addressLine1": "618 Rio Grande Blvd NW",
    "addressLine2": "",
    "city": "Albuquerque",
    "state": "NM",
    "zipOrPostalCode": "87104",
    "countryCode": "USA",
    "locationGLSegment": "120"
  }
}
```

--------------------------------

### Smartsheet Get Row Response JSON

Source: https://prismatic.io/docs/example-payloads/smartsheet/actions/rowGet.json

Example of the JSON object returned by the Get Row action, containing row metadata and cell values.

```json
{
  "data": {
    "id": 1490138716891012,
    "sheetId": 285065612683140,
    "rowNumber": 2,
    "parentId": 7119638251104132,
    "version": 49,
    "permalink": "https://app.smartsheet.com/sheets/jVm6gg56FHw65FFPGfQrHjhMCJ9R42jqMxMvHvP1?rowId=1490138716891012",
    "filteredOut": false,
    "expanded": true,
    "accessLevel": "OWNER",
    "createdAt": "2022-06-23T20:05:05Z",
    "createdBy": {
      "email": "example@company.com"
    },
    "modifiedAt": "2022-06-23T20:05:07Z",
    "modifiedBy": {
      "email": "example@company.com"
    },
    "cells": [
      {
        "columnId": 4275832638203780,
        "columnType": "TEXT_NUMBER",
        "value": "My Subtask 1",
        "objectValue": "My Subtask 1",
        "displayValue": "My Subtask 1",
        "format": ",,,,,,,,,,,,,,,1,"
      },
      {
        "columnId": 8779432265574276,
        "columnType": "CONTACT_LIST",
        "value": "example@company.com",
        "objectValue": {
          "objectType": "CONTACT",
          "email": "example@company.com",
          "name": "example@company.com"
        },
        "displayValue": "example@company.com"
      },
      {
        "columnId": 194445475899268,
        "columnType": "DATE",
        "value": "2022-06-23",
        "objectValue": {
          "objectType": "DATE",
          "value": "2022-06-23"
        }
      }
    ]
  }
}
```

--------------------------------

### Create Instance with Config and Labels

Source: https://prismatic.io/docs/cli/prism

Creates an instance while providing configuration variables and labels.

```text
prism instances:create --name 'Acme Inc' --description 'Acme Inc instance for Smith Rocket Co' --integration ${VERSION_ID} --customer ${CUSTOMER_ID} --config-vars '[{"key":"My Endpoint","value":"https://example.com/api"},{"key":"Do Thing?","value":"true"},{"key":"Acme Basic Auth","values":"${CREDENTIALS}"}]' --label 'Production' --label 'Paid'
```

--------------------------------

### Define an onInstanceDeploy trigger function

Source: https://prismatic.io/docs/llms-full.txt

This example demonstrates defining a trigger with an onInstanceDeploy function to perform setup tasks like creating folders in a third-party service during instance deployment.

```typescript
const acmeFolderWatcher = trigger({
  display: {
    label: "Acme Folder Watcher",
    description: "This trigger watches for changes in a specific folder",
  },
  scheduleSupport: "valid",
  synchronousResponseSupport: "invalid",
  inputs: {
    connection: input({
      label: "Acme Connection",
      type: "connection",
      required: true,
    }),
    folder: input({
      type: "string",
      label: "Folder",
      comments: "The folder where the Acme webhook will send events",
    }),
  },
  /** This function runs each time the flow is invoked (by webhook or schedule) */
  perform: async (_context, payload, _params) => {
    return Promise.resolve({ payload });
  },
  /** This function runs on instance deploy */
  onInstanceDeploy: async (context, params) => {
    context.logger.info(
      `Creating folder ${params.folder} in Acme for instance ${context.instance.id}`,
    );
    await createFolder({
      connection: params.connection,
      folderName: params.folder,
    });
  },
});
```

--------------------------------

### View command arguments and usage

Source: https://prismatic.io/docs/llms-full.txt

Display required arguments, flags, and usage examples for a specific command.

```text
Create a new Customer

USAGE
  $ prism customers:create -n <value> [--print-requests] [--quiet] [-d <value>] [-e <value>] [-l <value>]

FLAGS
  -d, --description=<value>  longer description of the customer
  -e, --externalId=<value>   external ID of the customer from your system
  -l, --label=<value>...     a label to apply to the customer
  -n, --name=<value>         (required) short name of the new customer

GLOBAL FLAGS
  --print-requests  Print all GraphQL requests that are issued
  --quiet           Reduce helpful notes and text

DESCRIPTION
  Create a new Customer

EXAMPLES
  Apply multiple labels to a customer

    $ prism customers:create --name "Widgets Inc" --externalId "abc-123" --label "Prod Customers" --label "Beta \
      Testers"
```

--------------------------------

### Install new toolchain dependencies

Source: https://prismatic.io/docs/llms-full.txt

Installs the recommended versions of TypeScript, Biome, tsdown, and Vitest.

```bash
npm install @prismatic-io/spectral@10.22.0
npm install --save-dev typescript@6.0.3
npm install --save-dev @biomejs/biome@2.5.1 tsdown@0.22.3 vitest@4.1.9
```

--------------------------------

### ServiceNow Get Attachment JSON Response

Source: https://prismatic.io/docs/example-payloads/servicenow/actions/getAttachment.json

Example of the JSON object returned by the Get Attachment action, containing file metadata and the download URL.

```json
{
  "data": {
    "result": {
      "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
      "size_bytes": "462",
      "download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
      "sys_updated_on": "2009-05-21 04:12:21",
      "sys_id": "615ea769c0a80166001cf5f2367302f5",
      "image_height": "",
      "sys_created_on": "2009-05-21 04:12:21",
      "file_name": "blocks.swf",
      "sys_created_by": "glide.maint",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "glide.maint",
      "sys_tags": "",
      "table_name": "content_block_programmatic",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "application/x-shockwave-flash",
      "size_compressed": "485"
    }
  }
}
```

--------------------------------

### Install graphql-request dependencies

Source: https://prismatic.io/docs/api/get-started/querying-with-nodejs

Install the necessary packages to use the graphql-request library.

```bash
npm install graphql graphql-request  
```

--------------------------------

### Configure Welcome Screens

Source: https://prismatic.io/docs/components/typeform

Example JSON structure for defining welcome screen layouts and properties.

```json
[ { "layout": { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "properties": { "decorative": true }, "type": "image" }, "placement": "left", "type": "split", "viewport_overrides": { "small": { "type": "wallpaper" } } }, "properties": { "button_text": "start", "description": "Cool description for the welcome", "show_button": true }, "ref": "nice-readable-welcome-ref", "title": "Welcome Title" } ]
```

--------------------------------

### BigCommerce Get Webhooks Response JSON

Source: https://prismatic.io/docs/example-payloads/bigcommerce/actions/getWebhooksAction.json

Example of the JSON payload returned by the Get Webhooks action, including pagination metadata and webhook configuration details.

```json
{
  "data": {
    "data": [
      {
        "id": 18048287,
        "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
        "store_hash": "sftg45fsd",
        "scope": "store/order/*",
        "destination": "https://665b65a6.ngrok.io/webhooks",
        "headers": {
          "custom-key": "developer-defined value"
        },
        "is_active": true,
        "created_at": 1561488106,
        "updated_at": 1561488106
      }
    ],
    "meta": {
      "pagination": {
        "count": 5,
        "current_page": 1,
        "per_page": 100,
        "total": 5,
        "total_pages": 1
      }
    }
  }
}
```

--------------------------------

### Pipedrive Get Files JSON Response

Source: https://prismatic.io/docs/example-payloads/pipedrive/actions/getFiles.json

Example of the successful JSON response object returned by the Get Files action, containing file details and pagination metadata.

```json
{
  "data": {
    "success": true,
    "data": [
      {
        "id": 123,
        "user_id": 456,
        "deal_id": 1,
        "person_id": 789,
        "org_id": 1,
        "product_id": 1,
        "activity_id": 1,
        "lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
        "log_id": null,
        "add_time": "2020-02-20 14:36:35",
        "update_time": "2020-02-20 14:57:33",
        "file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
        "file_type": "img",
        "file_size": 7801780,
        "active_flag": true,
        "inline_flag": false,
        "remote_location": "googledocs",
        "remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
        "cid": "",
        "s3_bucket": "",
        "mail_message_id": "",
        "mail_template_id": "",
        "deal_name": "",
        "person_name": "Person",
        "lead_name": "Test lead name",
        "org_name": "",
        "product_name": "",
        "url": "https://2a7f.pipedrive.com/v1/files/123/download",
        "name": "test file name",
        "description": "test file description"
      }
    ],
    "additional_data": {
      "pagination": {
        "start": 0,
        "limit": 100,
        "more_items_in_collection": true,
        "next_start": 100
      }
    }
  }
}
```

--------------------------------

### Configure Credentials and Create Instance

Source: https://prismatic.io/docs/llms-full.txt

Set up connection credentials as an escaped string and create an instance with specific configuration variables and labels.

```text
CREDENTIALS='[{"name":"username","type":"value","value":"my.username"},{"name":"password","type":"value","value":"Pa$$W0Rd"}]'
```

```text
prism instances:create --name 'Acme Inc' --description 'Acme Inc instance for Smith Rocket Co' --integration ${VERSION_ID} --customer ${CUSTOMER_ID} --config-vars '[{"key":"My Endpoint","value":"https://example.com/api"},{"key":"Do Thing?","value":"true"},{"key":"Acme Basic Auth","values":"${CREDENTIALS}"}]' --label 'Production' --label 'Paid'
```

--------------------------------

### Get Persons Response JSON

Source: https://prismatic.io/docs/example-payloads/pipedrive/actions/getPersons.json

Example of the data structure returned by the getPersons action.

```json
{
  "data": {
    "data": [
      {
        "id": 1,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Acme",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 1
        },
        "name": "John",
        "first_name": "John",
        "last_name": null,
        "open_deals_count": 0,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 5,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "value": "",
            "primary": true
          }
        ],
        "first_char": "t",
        "update_time": "2023-08-14 22:49:23",
        "delete_time": null,
        "add_time": "2023-04-06 02:51:24",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "label_ids": [],
        "im": [
          {
            "value": "",
            "primary": true
          }
        ],
        "postal_address": null,
        "postal_address_lat": null,
        "postal_address_long": null,
        "postal_address_subpremise": null,
        "postal_address_street_number": null,
        "postal_address_route": null,
        "postal_address_sublocality": null,
        "postal_address_locality": null,
        "postal_address_admin_area_level_1": null,
        "postal_address_admin_area_level_2": null,
        "postal_address_country": null,
        "postal_address_postal_code": null,
        "postal_address_formatted_address": null,
        "notes": null,
        "birthday": null,
        "job_title": null,
        "org_name": "Acme",
        "owner_name": "Test Developer",
        "primary_email": null,
        "5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": "15",
        "3cf151d1c54a8c13329a97403054d6306fe4680c": "17",
        "cc_email": "test-sandbox@pipedrivemail.com"
      },
      {
        "id": 2,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Acme",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 1
        },
        "name": "John",
        "first_name": "John",
        "last_name": null,
        "open_deals_count": 0,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "label": "work",
            "value": "john.doe@example.com",
            "primary": true
          }
        ],
        "first_char": "j",
        "update_time": "2023-07-13 21:26:05",
        "delete_time": null,
        "add_time": "2023-07-13 20:47:38",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null
```

--------------------------------

### Show All Components with Configuration

Source: https://prismatic.io/docs/embed/additional-screens/show-components

This example shows how to configure `showComponents()` with options like `usePopover`, `theme`, `autoFocusIframe`, and `filters`.

```tsx
import prismatic from "@prismatic-io/embedded";
import { useEffect } from "react";

const id = "components-div";

function ComponentListView() {
  useEffect(() => {
    prismatic.showComponents({
      selector: `#${id}`,
      usePopover: false,
      theme: "DARK",
      autoFocusIframe: true,
      filters: {
        components: {
          category: "Data Platforms",
        },
      },
    });
  }, []);

  return <div id={id}>Loading...</div>;
}

export default ComponentListView;

```

--------------------------------

### Log Query Variables

Source: https://prismatic.io/docs/api/common-queries/fetching-logs

Example variables for the FetchLogs query defining the start and end timestamps.

```json
{

  "timestampGte": "2026-04-22T00:15:30.726000+00:00",

  "timestampLte": "2026-04-22T16:15:28.510000+00:00"

}
```

--------------------------------

### Initialize Integration Project

Source: https://prismatic.io/docs/get-started/build-integrations/first-integration-code-native

Scaffold a new code-native integration directory using the Prismatic CLI.

```bash
prism integrations:init todo-slack-notifications
```

--------------------------------

### Stripe Get Charge JSON Response

Source: https://prismatic.io/docs/example-payloads/stripe/actions/getCharge.json

Example of the JSON object returned when retrieving a charge from Stripe.

```json
{
  "data": {
    "id": "ch_3MmlLrLkdIwHu7ix0snN0B15",
    "object": "charge",
    "amount": 2000,
    "amount_captured": 2000,
    "amount_refunded": 0,
    "application": null,
    "application_fee": null,
    "application_fee_amount": null,
    "balance_transaction": "txn_3MmlLrLkdIwHu7ix0uke3Ezy",
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": null,
      "phone": null
    },
    "calculated_statement_descriptor": "Stripe",
    "captured": true,
    "created": 1716397800,
    "currency": "usd",
    "customer": "cus_NffrFeUfNV2Hib",
    "description": "Subscription payment",
    "disputed": false,
    "failure_balance_transaction": null,
    "failure_code": null,
    "failure_message": null,
    "fraud_details": {},
    "invoice": null,
    "livemode": false,
    "metadata": {},
    "on_behalf_of": null,
    "outcome": {
      "network_status": "approved_by_network",
      "reason": null,
      "risk_level": "normal",
      "risk_score": 32,
      "seller_message": "Payment complete.",
      "type": "authorized"
    },
    "paid": true,
    "payment_intent": "pi_3MmlLrLkdIwHu7ix01zsk9pV",
    "payment_method": "pm_1MqM05LkdIwHu7ixlDxxO6Mc",
    "receipt_email": null,
    "receipt_number": null,
    "receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xTUFFTWdMa2RJd0h1N2l4KKvRgrIGMgaJUegnNYg6LBb4z3hP6dKHaUNVZK4XGfMqfMM6kQHaJxL_-EUNfHaUjL_GnRgZHkjwLnA",
    "refunded": false,
    "review": null,
    "shipping": null,
    "source_transfer": null,
    "statement_descriptor": null,
    "statement_descriptor_suffix": null,
    "status": "succeeded",
    "transfer_data": null,
    "transfer_group": null
  }
}
```

--------------------------------

### Retrieve Instance Configuration Variables

Source: https://prismatic.io/docs/api/common-queries/updating-config-variables

Example response showing the structure of an instance's required configuration variables.

```json
{
  "data": {
    "instance": {
      "name": "Acme Inventory",
      "configVariables": {
        "nodes": [
          {
            "id": "EXAMPLE",
            "requiredConfigVariable": {
              "key": "Inventory Field Mapping",
              "collectionType": "KEYVALUELIST",
              "dataType": "STRING",
              "defaultValue": "[]"
            },
            "value": "[]",
            "inputs": {
              "nodes": []
            }
          },
          {
            "id": "EXAMPLE2",
            "requiredConfigVariable": {
              "key": "Sync Inventory Item Metadata?",
              "collectionType": null,
              "dataType": "BOOLEAN",
              "defaultValue": "false"
            },
            "value": "false",
            "inputs": {
              "nodes": []
            }
          },
          {
            "id": "EXAMPLE3",
            "requiredConfigVariable": {
              "key": "Acme Inventory User/Pass",
              "collectionType": null,
              "dataType": "CONNECTION",
              "defaultValue": null
            },
            "value": null,
            "inputs": {
              "nodes": [
                {
                  "name": "password",
                  "type": "VALUE",
                  "value": ""
                },
                {
                  "name": "username",
                  "type": "VALUE",
                  "value": ""
                }
              ]
            }
          },
          {
            "id": "EXAMPLE4",
            "requiredConfigVariable": {
              "key": "Acme Inventory Endpoint",
              "collectionType": null,
              "dataType": "STRING",
              "defaultValue": ""
            },
            "value": "",
            "inputs": {
              "nodes": []
            }
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Pipedrive Get Deals Response JSON

Source: https://prismatic.io/docs/example-payloads/pipedrive/actions/getDeals.json

Example of the JSON payload returned when fetching deals from Pipedrive.

```json
{
  "data": {
    "data": [
      {
        "id": 1,
        "creator_user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "test person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 3
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Developer",
          "value": 2
        },
        "stage_id": 1,
        "title": "test deal",
        "value": 2,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:27",
        "update_time": "2024-09-27 14:25:28",
        "stage_change_time": null,
        "active": true,
        "deleted": false,
        "status": "open",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3",
        "close_time": null,
        "pipeline_id": 1,
        "won_time": null,
        "first_won_time": null,
        "lost_time": null,
        "products_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "participants_count": 1,
        "expected_close_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "local_won_date": null,
        "local_lost_date": null,
        "local_close_date": null,
        "origin": "ManuallyCreated",
        "origin_id": null,
        "channel": null,
        "channel_id": null,
        "stage_order_nr": 0,
        "person_name": "test person",
        "org_name": "test",
        "next_activity_subject": null,
        "next_activity_type": null,
        "next_activity_duration": null,
        "next_activity_note": null,
        "formatted_value": "$2",
        "weighted_value": 2,
        "formatted_weighted_value": "$2",
        "weighted_value_currency": "USD",
        "rotten_time": null,
        "owner_name": "Developer",
        "cc_email": "test-sandbox+deal1@pipedrivemail.com",
        "org_hidden": false,
        "person_hidden": false
      },
      {
        "id": 2,
        "creator_user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "awesome person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 4
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Developer",
          "value": 2
        },
        "stage_id": 4,
        "title": "test deal 2",
        "value": 3,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:53",
        "update_time": "2024-09-27 14:31:57",
        "stage_change_time": "2024-09-27 14:31:45",
        "active": false,
        "deleted": false,
        "status": "won",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3"
```

--------------------------------

### Get Agreement JSON Response

Source: https://prismatic.io/docs/example-payloads/adobe-acrobat-sign/actions/getAgreement.json

Example of the JSON payload returned when retrieving details for a specific agreement.

```json
{
  "data": {
    "id": "CBJCHBCAABAAQ8h3W7QwzG8Xq6t9R5p4N2K",
    "name": "Service Agreement 2024",
    "type": "AGREEMENT",
    "state": "IN_PROCESS",
    "status": "OUT_FOR_SIGNATURE",
    "signatureType": "ESIGN",
    "locale": "en_US",
    "senderEmail": "sender@acme.com",
    "message": "Please review and sign this service agreement.",
    "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
    "workflowId": "CBJCHBCAABAAFvT4qsB8Y9nJk7L6m5W2pXr",
    "parentId": "",
    "externalId": {
      "id": "agreement-1234"
    },
    "createdDate": "2024-03-15T10:30:00Z",
    "expirationTime": "2024-04-15T10:30:00Z",
    "lastEventDate": "2024-03-15T11:45:00Z",
    "hasFormFieldData": false,
    "hasSignerIdentityReport": false,
    "documentVisibilityEnabled": true,
    "isDocumentRetentionApplied": false,
    "senderSigns": "FIRST",
    "firstReminderDelay": 0,
    "reminderFrequency": "DAILY_UNTIL_SIGNED",
    "sendType": "REGULAR_SEND",
    "agreementSettingsInfo": {
      "hipaaEnabled": false,
      "canEditFiles": true,
      "canEditAgreementSettings": true,
      "canEditElectronicSeals": false
    },
    "emailOption": {
      "sendOptions": {
        "initEmails": "ALL",
        "inFlightEmails": "ALL",
        "completionEmails": "ALL"
      }
    },
    "participantSetsInfo": [
      {
        "id": "CBJCHBCAABAArole1",
        "role": "SIGNER",
        "order": 1,
        "name": "Signer",
        "memberInfos": [
          {
            "id": "CBJCHBCAABAAmem1",
            "email": "signer@example.com",
            "name": "Jane Signer",
            "status": "ACTIVE",
            "deliverableEmail": true
          }
        ]
      }
    ],
    "fileInfos": [
      {
        "label": "Service Agreement",
        "document": {
          "id": "CBJCHBCAABAAdoc1",
          "name": "service-agreement.pdf",
          "label": "Service Agreement",
          "mimeType": "application/pdf",
          "numPages": 4,
          "createdDate": "2024-03-15T10:30:00Z"
        }
      }
    ]
  }
}
```

--------------------------------

### Initialize Shopify App

Source: https://prismatic.io/docs/components/shopify

Scaffold a new Shopify app project using the Shopify CLI.

```bash
shopify app init
```

--------------------------------

### Get Order JSON Response

Source: https://prismatic.io/docs/example-payloads/shipstation/actions/getOrder.json

Example of the JSON object returned by the ShipStation API when fetching order details.

```json
{
  "data": {
    "orderId": 94113592,
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "createDate": "2015-07-16T14:00:34.8230000",
    "modifyDate": "2015-09-08T11:03:12.3800000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerId": 37701499,
    "customerUsername": "headhoncho@whitehouse.gov",
    "customerEmail": "headhoncho@whitehouse.gov",
    "billTo": {
      "name": "The President",
      "company": null,
      "street1": null,
      "street2": null,
      "street3": null,
      "city": null,
      "state": null,
      "postalCode": null,
      "country": null,
      "phone": null,
      "residential": null,
      "addressVerified": null
    },
    "shipTo": {
      "name": "The President",
      "company": "US Govt",
      "street1": "1600 Pennsylvania Ave",
      "street2": "Oval Office",
      "street3": null,
      "city": "Washington",
      "state": "DC",
      "postalCode": "20500",
      "country": "US",
      "phone": "555-555-5555",
      "residential": false,
      "addressVerified": "Address validation warning"
    },
    "items": [
      {
        "orderItemId": 128836912,
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": null,
        "shippingAmount": null,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "productId": 7239919,
        "fulfillmentSku": null,
        "adjustment": false,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      },
      {
        "orderItemId": 128836913,
        "lineItemKey": null,
        "sku": "DISCOUNT CODE",
        "name": "10% OFF",
        "imageUrl": null,
        "weight": {
          "value": 0,
          "units": "ounces"
        },
        "quantity": 1,
        "unitPrice": -20.55,
        "taxAmount": null,
        "shippingAmount": null,
        "warehouseLocation": null,
        "options": [],
        "productId": null,
        "fulfillmentSku": null,
        "adjustment": true,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      }
    ],
    "orderTotal": 194.43,
    "amountPaid": 218.73,
    "taxAmount": 5,
    "shippingAmount": 10,
    "customerNotes": "Please ship as soon as possible!",
    "internalNotes": "Customer called and would like to upgrade shipping",
    "gift": true,
    "giftMessage": "Thank you!",
    "paymentMethod": "Credit Card",
    "requestedShippingService": "Priority Mail",
    "carrierCode": "fedex",
    "serviceCode": "fedex_home_delivery",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "holdUntilDate": null,
    "weight": {
      "value": 48,
      "units": "ounces"
    },
    "dimensions": {
      "units": "inches",
      "length": 7,
      "width": 5,
      "height": 6
    },
    "insuranceOptions": {
      "provider": "carrier",
      "insureShipment": true,
      "insuredValue": 200
    },
    "internationalOptions": {
      "contents": null,
      "customsItems": null,
      "nonDelivery": null
    },
    "advancedOptions": {
      "warehouseId": 24079,
      "nonMachinable": false,
      "saturdayDelivery": false,
      "containsAlcohol": false,
      "mergedOrSplit": false,
      "mergedIds": [],
      "parentId": null,
      "storeId": 26815,
      "customField1": "Custom data that you can add to an order. See Custom Field #2 & #3 for more info!",
      "customField2": "Per UI settings, this information can appear on some carrier's shipping labels. See link below",
      "customField3": "https://help.shipstation.com/hc/en-us/articles/206639957",
      "source": "Webstore",
      "billToParty": null,
      "billToAccount": null,
      "billToPostalCode": null,
      "billToCountryCode": null
    },
    "tagIds": null,
    "userId": null,
    "externallyFulfilled": false,
    "externallyFulfilledBy": null
  }
}
```
Tokens:
Raw