Skip to main content

Gist Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Gist location.
get_gist_api.png

Gist

  1. Click the + icon on the Nexset that will be sent to the Gist destination, and select the Send to Destination option from the menu.

  2. Select the Gist connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Gist organization, and click Next; or, create a new Gist credential for use in this flow.

  3. In Nexla, Gist destinations can be created using pre-built endpoint templates, which expedite destination setup for common Gist endpoints. Each template is designed specifically for the corresponding Gist endpoint, making destination setup easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Gist destinations can also be configured manually, allowing you to send data to Gist endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Gist endpoints. Each template is designed specifically for the corresponding Gist endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

    Create or Update Contact

    Creates a new Gist contact or updates an existing contact by matching on email address or user_id, making it ideal for ongoing contact synchronization.

    • Sends a POST request to https://api.getgist.com/contacts with the contact payload.
    • If a contact with the provided email or user_id already exists, their record will be updated rather than duplicated.

    This endpoint is idempotent for upsert operations. Include at least one of email or user_id in each record for matching to work correctly.

    Create Campaign

    Creates a new email or marketing campaign in the Gist workspace.

    • Sends a POST request to https://api.getgist.com/campaigns with the campaign configuration payload.
    • Each record should include the campaign name, type, and associated content settings.

    The Gist API is rate-limited to 100 requests per 10 seconds. Avoid sending high volumes of campaign creation requests in rapid succession.

    Create Conversation

    Creates a new outbound conversation to initiate messaging with a Gist contact.

    Ensure the target contact exists in Gist before creating a conversation. Use the Create or Update Contact endpoint to create contacts if needed.

    Send Conversation Reply

    Sends a reply message within an existing Gist conversation, enabling automated follow-up messaging workflows.

    Use the List Conversations source endpoint to retrieve valid conversation IDs. Replies are appended to the existing conversation thread.

    Create Event

    Creates a new event to track a contact's interaction with your product, which can be used to trigger automation rules or segment contacts.

    • Sends a POST request to https://api.getgist.com/events with the event payload.
    • Each record should include the event name, the contact identifier, and optional event properties.

    Events are associated with contacts by email or user_id. Custom event properties can be included to provide additional context for automation rules.

    Bulk Apply Tag to Contacts

    Applies a tag to one or more contacts in bulk using the tag ID, enabling efficient batch tagging operations.

    The tag must already exist before it can be applied. Use the Create Tag endpoint to create tags if needed, and the List Contacts endpoint to retrieve contact IDs.

    Create Segment

    Creates a new contact segment in the Gist workspace for organizing and targeting groups of contacts.

    The Gist API is rate-limited to 100 requests per 10 seconds. Plan segment creation accordingly.

    Create Tag

    Creates a new tag in the Gist workspace for categorizing and filtering contacts.

    Tag names must be unique within the workspace. The returned tag ID can be used with the Bulk Apply Tag or Remove Tag from Contacts endpoints.

    Update Tag

    Renames or updates an existing Gist tag by its unique ID.

    • Sends a PATCH or PUT request to the Gist tags endpoint with the updated tag data.
    • Configure the following parameter: Id — the unique ID of the tag to update.

    Use the List Contacts or other endpoints that return tag data to discover valid tag IDs.

    Delete Contact

    Permanently deletes a Gist contact and all of their associated conversation history.

    This action is irreversible. All data associated with the contact, including conversation history, will be permanently removed.

    Delete Tag

    Permanently deletes a Gist tag by its unique identifier, removing it from all associated contacts.

    • Sends a DELETE request to the Gist tags endpoint for the specified tag.
    • Configure the following parameter: Id — the unique ID of the tag to delete.

    Deleting a tag will remove it from all contacts it is currently applied to. This action cannot be undone.

    Remove Tag from Contacts

    Removes a tag from one or more contacts in bulk using the tag ID.

    This removes the tag association from contacts without deleting the contacts or the tag itself.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a test payload to verify the destination is configured correctly.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. A test payload will be sent and the result will be displayed in the Endpoint Test Result panel on the right.

  • If the test result is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again to verify the updated configuration.

Configure Manually​

Gist destinations can also be manually configured to send data to any valid Gist API endpoint. You can also configure Nexla to automatically send the response received from the Gist API after each call to a new Nexla webhook data source. This is useful for tracking the status of write operations or capturing data returned by the Gist API after creating or updating records.

First, select the API method that will be used for calls to the Gist API from the Method pulldown menu. Common methods for Gist write operations include:

  • POST: For creating new contacts, events, tags, or other resources
  • PUT: For replacing an existing resource in full
  • PATCH: For updating specific fields of an existing contact or resource
  • DELETE: For removing a contact, tag, or other resource

Refer to the Gist Developer Hub to confirm which HTTP method is required for each specific operation. For example, creating a contact uses POST, while updating an existing contact's attributes uses PATCH.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Gist API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Gist API accepts data in JSON format. Select JSON as the content format to ensure that contact attributes, event properties, and other data fields are properly serialized in a format that the Gist API can process.

API Endpoint URL​

  1. Enter the URL of the Gist API endpoint to which you want to send the Nexset data in the URL field. For update or upsert operations, include the ID of the contact or resource to be updated at the end of the URL.

    The Gist API base URL is https://api.getgist.com. Common write endpoint paths include:

    • https://api.getgist.com/contacts — Create a new contact or update an existing contact (POST creates; matched records are updated automatically)
    • https://api.getgist.com/contacts/{'{id}'} — Update a specific contact by ID (PATCH or PUT)
    • https://api.getgist.com/events — Create a new event and associate it with a contact
    • https://api.getgist.com/tags — Create a new tag
    • https://api.getgist.com/tags/{'{id}'}/contacts — Associate a tag with contacts

The Gist contacts endpoint is idempotent for create/update operations: if a contact with the provided email or user_id already exists, the API will update that contact rather than creating a duplicate. This makes it safe to run recurring flows that sync contact data from external systems.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header here—Nexla automatically includes it from your saved Gist credential. The Content-Type: application/json header is also handled automatically when JSON is selected as the content format.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Gist destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Use attribute exclusion to filter out internal metadata, Nexla system fields, or any data fields that are not valid Gist API properties—such as fields that don't correspond to standard or custom contact attributes in your Gist workspace.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Rate Limiting

The Gist API is rate-limited to 100 requests per 10 seconds per workspace. When configuring high-volume destination flows, use record batching and control your flow's execution frequency to stay within this limit. Requests exceeding the rate limit receive an HTTP 429 response, which may pause or retry the data flow.

Response Webhook​

Optional

Nexla can automatically send the response received from the Gist API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Enabling the response webhook is recommended when writing contacts or events to Gist, as it allows you to capture the Gist-assigned id for each newly created record and use it in downstream data flows.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Gist API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Gist API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Gist API using the current settings.

Save & Activate the Destination​

  • 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.