Skip to main content

Gist

Gist is an all-in-one customer messaging and engagement platform that combines live chat, email marketing, chatbots, a knowledge base, and event tracking. The Gist connector reads contacts, tags, segments, events, conversations and conversation counts, drip campaigns, forms and form submissions, knowledge base articles and collections, ecommerce stores, teams, and teammates, and can create and update contacts, tag contacts, track events, manage conversations, write knowledge base content, and sync ecommerce stores, customers, products, and orders.

Gist icon

Power end-to-end data operations for your Gist API with Nexla. Our bi-directional Gist connector is purpose-built for Gist, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Gist or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Gist workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Gist API (https://api.getgist.com) with your Gist workspace's API key, which Gist accepts as a Bearer token in the Authorization header. To find the key:

  1. Sign in to your Gist workspace at app.getgist.com.

  2. Open Settings, and select API Key in the integration settings.

  3. Copy the API key.

The API key gives access to your workspace's private contact data, so keep it within your company and don't share it publicly. See the Authentication section of the Gist API reference and Gist's Build an integration guide for details.

Gist API rate limits

The Gist API is limited to 100 requests per 10 seconds per workspace; requests over the limit receive an HTTP 429 response. Paged templates make one request per page of 50 records, so plan schedules for large workspaces accordingly. See Rate Limits.

Authenticate​

Credentials required​

Authenticate using GetGist API key passed in Authorization header.

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Gist API key in the API Key Value field. Enter the key only; Nexla adds the Bearer prefix and sends it in the Authorization header of every request.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading the contact list from your Gist workspace.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Gist connector tile, then select the credential that will be used to connect to your Gist workspace, and click Next; or, create a new Gist credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Gist endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page, 50 records at a time. Templates that need an ID read one object; use the matching list template to find the ID.

Contacts​

List all contacts in the workspace (users and leads)

Lists all contacts in the workspace, both users and leads, including each contact's ID, email address, name, user ID, tags, segments, and custom properties. Results are paged automatically, 50 records per page.

Get contact

Retrieves one contact by its Gist ID.

  • Enter the Id. Use the List all contacts in the workspace (users and leads) template to find it.
  • See the Gist API reference for the response fields.

Get Contact by Email

Looks up one contact by email address.

Get Contact by User ID

Looks up one contact by the user ID that your own system assigned to it.

  • Enter the contact's User ID from your own system.
  • See the Gist API reference for the response fields.

Get Contact Batch Import Status

Retrieves the status (QUEUED, IN_PROGRESS, or COMPLETED), imported count, and errors of a batch contact import.

  • Enter the Batch ID returned by the Batch Create or Update Contacts destination template.
  • See the Gist API reference for the response fields.

List Tags

Lists all contact tags with their IDs and names. Results are paged automatically, 50 records per page.

List all segments in the workspace

Lists all contact segments in the workspace. Results are paged automatically, 50 records per page.

Get segment

Retrieves one segment by ID, optionally with the number of contacts in it.

  • Enter the Id. Use the List all segments in the workspace template to find it.
  • Select Include contact count: true (default) or false.
  • See the Gist API reference for the response fields.

List all events tracked in the workspace

Lists the events tracked in the workspace. Results are paged automatically, 50 records per page.

List Subscription Types

Lists subscription types, the email opt-in categories contacts can subscribe to. Results are read in a single request.

Retrieve a single subscription type by ID

Retrieves one subscription type by ID.

  • Enter the Subscription Type ID. Use the List Subscription Types template to find it.

Conversations​

List all conversations in the workspace

Lists all conversations in the workspace. Results are paged automatically, 50 records per page.

Retrieve a single conversation by ID

Retrieves one conversation by ID.

  • Enter the Conversation ID. Use the List all conversations in the workspace template to find it.
  • See the Gist API reference for the response fields.

List all messages in a conversation

Lists the messages in one conversation. Results are paged automatically, 50 records per page.

  • Enter the Conversation ID. Use the List all conversations in the workspace template to find it.
  • See the Gist API reference for the response fields.

Get Conversation Counts

Counts the conversations in the workspace by state: open, closed, snoozed, assigned, and unassigned.

List Team Conversation Counts

Returns the open, snoozed, and closed conversation counts for each team.

List Teammate Conversation Counts

Returns the open, snoozed, and closed conversation counts for each teammate.

Campaigns and forms​

List all drip campaigns in the workspace

Lists all drip campaigns in the workspace. Results are paged automatically, 50 records per page.

Get campaign

Retrieves one drip campaign by ID.

  • Enter the Id. Use the List all drip campaigns in the workspace template to find it.
  • See the Gist API reference for the response fields.

List all forms in the workspace

Lists all forms in the workspace. Results are paged automatically, 50 records per page.

Retrieve a single form by ID

Retrieves one form by ID.

  • Enter the Form ID. Use the List all forms in the workspace template to find it.
  • See the Gist API reference for the response fields.

List all form submissions

Lists the submissions of one form. Results are paged automatically, 50 records per page.

  • Enter the Form ID. Use the List all forms in the workspace template to find it.
  • See the Gist API reference for the response fields.

Knowledge base​

List all knowledge base articles in the workspace

Lists all knowledge base articles. Results are paged automatically, 50 records per page.

Get Article

Retrieves one knowledge base article with all of its translations.

  • Enter the ID. Use the List all knowledge base articles in the workspace template to find it.
  • See the Gist API reference for the response fields.

List Collections

Lists all knowledge base collections, which group articles. Results are paged automatically, 50 records per page.

Get Collection

Retrieves one knowledge base collection with its translations.

  • Enter the ID. Use the List Collections template to find it.
  • See the Gist API reference for the response fields.

Get Knowledge Base Settings

Retrieves the knowledge base settings, such as domain, languages, SEO, and branding.

Ecommerce​

List Ecommerce Stores

Lists the ecommerce stores linked to the workspace. Results are read in a single request.

Get Ecommerce Store

Retrieves one ecommerce store.

  • Enter the Store ID. Use the List Ecommerce Stores template to find it.
  • See the Gist API reference for the response fields.

Get Ecommerce Customer

Retrieves one customer of an ecommerce store.

  • Enter the Store ID. Use the List Ecommerce Stores template to find it.
  • Enter the Customer ID of the customer in the store.
  • See the Gist API reference for the response fields.

Get Ecommerce Product

Retrieves one product of an ecommerce store.

  • Enter the Store ID. Use the List Ecommerce Stores template to find it.
  • Enter the Product ID of the product in the store.
  • See the Gist API reference for the response fields.

Get Ecommerce Product Variant

Retrieves one variant of an ecommerce product.

  • Enter the Store ID. Use the List Ecommerce Stores template to find it.
  • Enter the Product ID of the product in the store.
  • Enter the Variant ID of the product variant.
  • See the Gist API reference for the response fields.

Get Ecommerce Product Category

Retrieves one product category of an ecommerce store.

  • Enter the Store ID. Use the List Ecommerce Stores template to find it.
  • Enter the Category ID of the product category in the store.
  • See the Gist API reference for the response fields.

Teams and workspace​

List Teams

Lists the workspace's teams and the IDs of their teammates. Results are read in a single request.

Get Team

Retrieves one team and the IDs of its teammates.

  • Enter the ID. Use the List Teams template to find it.
  • See the Gist API reference for the response fields.

List Teammates

Lists the workspace's teammates, including their status, inbox seat, and teams. Results are read in a single request.

Get Teammate

Retrieves one teammate.

  • Enter the ID. Use the List Teammates template to find it.
  • See the Gist API reference for the response fields.

Get Workspace Meta

Retrieves the workspace ID, app ID, scopes, and expiry of the API key the credential uses. Use it to confirm which workspace the credential connects to.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Gist sources can also be manually configured to ingest data from any valid Gist API endpoint, including endpoints not covered by the pre-built templates, chained API calls to fetch data from multiple endpoints, or custom request parameters such as the optional filters on the contacts list. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Gist endpoint URLs take the form https://api.getgist.com/.... List responses wrap their records in a named array, for example $.contacts[*] for /contacts, and page with the page and per_page query parameters (50 records per page by default, at most 60). You do not need to add the Authorization header; Nexla adds it from your Gist credential. See the Gist API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Gist data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Gist destination, and select the Send to Destination option from the menu. Select the Gist connector from the list of available destination connectors, then select the credential that will be used to connect to your Gist workspace, and click Next; or, create a new Gist credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Gist endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the JSON body of one request, one record at a time. ID settings, such as a conversation or store ID, are fixed on the destination and apply to every record it sends, so each record acts on the same object. Templates marked Side effect delete data or message contacts in ways that cannot be undone from Nexla.

Contacts​

Create or Update Contact

Creates a contact from each record, or updates the existing contact when the record's email or user_id matches one. Records can carry name, phone, custom_properties, and tags.

Batch Create or Update Contacts

Queues a batch create-or-update of contacts. Each record holds a contacts array. Gist returns a batch_id; use the Get Contact Batch Import Status source template to follow the import.

Delete a contact and all associated conversation history

Deletes a contact by its Gist ID.

  • Side effect: permanently deletes the contact and all of their conversations and email history.
  • Enter the Id. Use the List all contacts in the workspace (users and leads) source template to find it.
  • See the Gist API reference for details.

Delete Contact by Email

Deletes the contact with a given email address.

  • Side effect: permanently deletes the contact and all of their conversations and email history.
  • Enter the contact's Email address.
  • See the Gist API reference for details.

Delete Contact by User ID

Deletes the contact with a given user ID from your own system.

  • Side effect: permanently deletes the contact and all of their conversations and email history.
  • Enter the contact's User ID from your own system.
  • See the Gist API reference for details.

Track Event

Tracks an event for a contact from each record, for example {"event_name": "Clicked Signup Button", "email": "jane@example.com"}. Records can also carry properties and occurred_at.

  • No additional parameters are required.

Attach Contact to Subscription Type

Opts a contact in to a subscription type. Each record identifies the contact by email, user_id, or contact_id, with subscribed_status set to true.

  • Enter the ID. Use the List Subscription Types source template to find it.
  • See the Gist API reference for details.

Detach Contact from Subscription Type

Opts a contact out of a subscription type. Each record identifies the contact by email, user_id, or contact_id, with subscribed_status set to false.

  • Side effect: the contact stops receiving that subscription type's emails.
  • Enter the ID. Use the List Subscription Types source template to find it.
  • See the Gist API reference for details.

Tags​

Create a new tag

Creates a tag from each record, for example {"name": "VIP"}. Tag names are case-insensitive, and sending an existing name does not create a duplicate.

  • No additional parameters are required.

Rename / Update a Tag

Renames a tag. Each record holds the tag's id and its new name.

Add a Tag to Contacts

Tags up to 50 contacts at once. Each record holds the tag name and a contacts array of objects with an id, email, or user_id. Gist creates the tag if it does not exist.

Remove a Tag from Contacts

Removes a tag from contacts. Each record holds the tag id or name and a contacts array in which each contact has "untag": true. The contacts and the tag are not deleted.

Delete a tag

Deletes a tag.

  • Side effect: permanently deletes the tag and removes it from all contacts.
  • Enter the Id. Use the List Tags source template to find it.
  • See the Gist API reference for details.

Conversations​

Create Conversation

Creates a conversation initiated by a contact from each record. Each record holds from (the contact's id, user_id, or email), body, and optionally title.

Send a reply message in an existing conversation

Adds a reply or an internal note to a conversation. Each record holds message_type (reply or note), body, and a teammate_id or the contact's id, user_id, or email.

  • Side effect: a teammate reply is sent to the contact.
  • Enter the Id. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Assign Conversation

Assigns a conversation to a teammate or team. Each record holds teammate_id, assignee_id, and assignee_type.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Unassign Conversation

Unassigns a conversation. Each record holds teammate_id and assignee_id set to null.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Close Conversation

Closes a conversation. Each record holds state set to closed, and a teammate_id or type set to bot.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Snooze Conversation

Snoozes a conversation until a given time. Each record holds state set to snoozed, snooze_until, and a teammate_id or type set to bot.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Reopen Conversation

Reopens a snoozed or closed conversation. Each record holds state set to open, and a teammate_id or type set to bot.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Prioritize Conversation

Marks a conversation as priority, from the priority value in each record.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Update Conversation

Sets a conversation's title or custom properties from each record.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Tag Conversation

Applies tags to a conversation message. Each record holds comma-separated tags and the message_id.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Untag Conversation

Removes a tag from a conversation message. Each record holds tag_id and message_id.

  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Delete Conversation

Deletes a conversation.

  • Side effect: permanently deletes the conversation and its messages.
  • Enter the ID. Use the List all conversations in the workspace source template to find it.
  • See the Gist API reference for details.

Campaigns and forms​

Subscribe / Unsubscribe Contact to Campaign

Subscribes a contact to a drip campaign, or unsubscribes them. Each record holds the campaign id and the contact's email or user_id; add "unsubscribed": true to unsubscribe.

  • Side effect: subscribing starts sending the campaign's emails to the contact.
  • See the Gist API reference for details.

Subscribe Contact to Form

Submits a form for a contact. Each record holds the form fields, consent, and page data. Gist creates or updates the contact and records a form submission.

  • Enter the ID. Use the List all forms in the workspace source template to find it.
  • See the Gist API reference for details.

Knowledge base​

Create Article

Creates a knowledge base article from each record, with translations (each with author_id, title, html_text, and status).

  • Side effect: a published article is public on your help center.
  • See the Gist API reference for details.

Update Article

Updates a knowledge base article with each record, for example its translations, parent_id, or status.

  • Enter the ID. Use the List all knowledge base articles in the workspace source template to find it.
  • See the Gist API reference for details.

Delete Article

Deletes a knowledge base article.

  • Side effect: permanently deletes the article.
  • Enter the ID. Use the List all knowledge base articles in the workspace source template to find it.
  • See the Gist API reference for details.

Create Collection

Creates a knowledge base collection from each record, with translations (each with name, description, and icon).

Update Collection

Updates a knowledge base collection with each record. Gist uses POST for this update.

  • Enter the ID. Use the List Collections source template to find it.
  • See the Gist API reference for details.

Delete Collection

Deletes a knowledge base collection.

  • Side effect: permanently deletes the collection.
  • Enter the ID. Use the List Collections source template to find it.
  • See the Gist API reference for details.

Ecommerce​

Create Ecommerce Store

Links a new ecommerce store to the workspace from each record.

Update Ecommerce Store

Updates an ecommerce store with each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • See the Gist API reference for details.

Create Ecommerce Customer

Adds a customer to a store from each record. Gist also creates or updates the linked contact.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • See the Gist API reference for details.

Update Ecommerce Customer

Updates a store customer, and its linked contact, with each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Customer ID of the customer in the store.
  • See the Gist API reference for details.

Create Ecommerce Product

Adds a product to a store from each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • See the Gist API reference for details.

Update Ecommerce Product

Updates a store product with each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Product ID of the product in the store.
  • See the Gist API reference for details.

Create Ecommerce Product Variant

Adds a variant to a product from each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Product ID of the product in the store.
  • See the Gist API reference for details.

Update Ecommerce Product Variant

Updates a product variant with each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Product ID of the product in the store.
  • Enter the Variant ID of the product variant.
  • See the Gist API reference for details.

Create Ecommerce Product Category

Adds a product category to a store from each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • See the Gist API reference for details.

Update Ecommerce Product Category

Updates a product category with each record.

  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Category ID of the product category in the store.
  • See the Gist API reference for details.

Create Ecommerce Order

Creates an order from each record.

  • Side effect: adds an order event to the contact's timeline, updates their lifetime value, and can trigger order workflows.
  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • See the Gist API reference for details.

Update Ecommerce Order

Updates an order with each record.

  • Side effect: status changes (paid, refunded, cancelled) add contact events and change the contact's lifetime value.
  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Order ID of the order in the store.
  • See the Gist API reference for details.

Create or Update Customer Cart

Creates or updates a customer's cart from each record.

  • Side effect: the cart enables Gist's "Abandoned a cart" workflows, which can email the contact.
  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Customer ID of the customer in the store.
  • See the Gist API reference for details.

Delete Customer Cart

Removes a customer's cart.

  • Side effect: the cart is deleted.
  • Enter the Store ID. Use the List Ecommerce Stores source template to find it.
  • Enter the Customer ID of the customer in the store.
  • See the Gist API reference for details.

Manual configuration​

Gist destinations can also be manually configured to send data to any valid Gist API endpoint. You can also configure Nexla to send the response that Gist returns after each call to a new Nexla webhook data source, for example to capture the Gist-assigned id of each created record. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Gist API accepts JSON request bodies. Check the Gist API reference for the method each operation needs: several updates use POST rather than PATCH, for example renaming a tag or updating a collection.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Gist endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to Gist until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.