ImpulseSync™ User Manual
HomePricingContact Us
  • Introduction
    • What is Impulse?
  • Crash Course of ImpulseSync
    • Overview Of ImpulseSync
    • Step 1: Endpoints
      • Endpoint Configuration
    • Step 2: Jobs
      • Job Configuration
      • Step 2a: Content manipulators
      • Step 2b: Content mapper
    • Step 3: Syncing
  • Getting Started
    • Core Concepts
    • Creating Endpoints
    • Creating Jobs
    • Starting a Transaction
    • Transaction Reports
    • Automating Jobs with Pipelines
    • Scripting Post Sync
    • Scheduling Jobs and Pipelines
    • Dashboard
    • Managing Jobs/Pipelines
    • Content Mapper
      • Aligning Mismatched Content
      • Connector Matrix
      • Locked Fields
      • Content Aligner
      • Aligning Content Challenges
  • Reports
    • Reports Screen
    • Debug Report
    • Messages
  • Connectors
    • Common Job Options
    • All Connectors List
    • Source Connectors
      • Contentful
      • Contentstack
      • dotCMS
      • Drupal v7
      • Drupal v9
      • GitHub
      • GraphQL
      • MS Teams
      • SCP
      • Snapshot
      • Strapi v3
      • Strapi v4
    • Destination Connectors
      • Contentful
      • Contentstack
      • dotCMS
      • SCP
      • Strapi v3
      • Strapi v4
  • Content Manipulators
    • Common Manipulator Options
    • Add Replace Field
    • AI(Artificial intelligence)
    • Change ID Manipulator
    • CSV Store Manipulator
    • Dynamic Job Store Manipulator
    • File to Text
    • Folder Manipulator
    • Get and Set Field
    • Language
    • Liquid Field
      • Liquid On the Quick
      • Basics
        • Impulse Values
        • Impulse Variables
        • Operators
        • Truthy and falsy
        • Types
        • Whitespace control
      • Tags
        • Control flow
        • Impulse Content Objects
        • Iteration
        • Utility
        • Variable
      • Filters
        • abs
        • append
        • capitalize
        • ceil
        • compact
        • concat
        • date
        • date_str
        • default
        • divided_by
        • downcase
        • escape
        • escape_once
        • first
        • floor
        • getStoredValue
        • htmlQuery
        • htmlReplace
        • idMap
        • join
        • jq
        • json
        • last
        • lstrip
        • map
        • minus
        • modulo
        • newline_to_br
        • plus
        • prepend
        • remove
        • remove_first
        • replace
        • replace_first
        • reverse
        • round
        • rstrip
        • section
        • sections
        • size
        • slice
        • sort
        • sort_natural
        • split
        • str_to_date
        • strip
        • strip_html
        • strip_newlines
        • times
        • truncate
        • truncatewords
        • type
        • uniq
        • upcase
        • utl_decode
        • url_encode
      • Liquid Playground
    • Markdown
    • Regex
    • Relationship
    • Store Field
    • Tidy
  • Time Machine
    • Snapshot
    • Viewing Snapshots
    • Delivery from Snapshots
  • Cookbook Recipes
    • Adding Fields
    • Aligning Content between Endpoints
    • Avoid overriding Fields
    • Avoid syncing Content Types
    • Combing Fields
    • Default Field Value
    • File (.doc) to Structured Content
    • File (.docx) to Structured Content - Expanded
    • HTML to Structured Content
    • Language (Locale) mismatch between endpoints
    • Paths/IDs Changed
    • Reference to Value
    • Single Content Type to Multiple
    • Splitting Content with Reference
    • Syncing Content with Languages
    • Text Select to Boolean
    • Text to Reference
    • Text to Reference - liquid
    • Two Sources to One Destination
    • Changing a folder path
    • Combining data between content types
    • Converting HTML Sections
    • JSON object to reference
    • Use CSV to convert values
    • Storing fields with Store field motator
  • Troubleshooting
    • What to do if I run into a Job Problem
    • Troubleshooting via UI
    • Submitting a ticket
  • Using Impulse Headlessly
    • Getting Started with cURL
      • Creating Endpoints
      • Creating Jobs
      • Starting a Transaction
      • Transaction Reports
      • Automating Jobs with Pipelines
      • Scheduling Jobs and Pipelines
      • Aligning Mismatched Content
      • Scripting Post Sync
  • Organization Tier Restrictions
  • Content Storage Options
Powered by GitBook
On this page
  1. Crash Course of ImpulseSync
  2. Step 1: Endpoints

Endpoint Configuration

PreviousStep 1: EndpointsNextStep 2: Jobs

Last updated 1 year ago

Endpoint configuration can differ from each connector but were going to go over a few specific connectors to help understand what exactly these endpoints are for, and how we can set them up to use them in our jobs. To start off lets take a look at our Contentful Connector endpoint here we have Four properties to set up -Token: the content mangaement token to use Contentful's API. (Ex: this is where we would put our contentful token for each individual space that we want to connect to) -Space: The space that should be searched for content and content should be synced to. (Ex: This is the space ID that we would enter to have impulse access and identify where the space is in the contentful instance) -Environment: This is the environment ID that your contentful space uses, this is what we use in addition to the space and token to connect to the contentful space in order to find the content, so you can have multiple environments without impulse syncing content from each environment. -rateLimitperSecond: This is used to control the rate at which certain operations can be executed to prevent excessive usage or abuse of resources, this can be set at 7 this is the default rate limit for most endpoints and connectors.

Additionally to each custom connector configuration there is also a source and destination part to set up. It's the same config as if you were to set a source endpoint and its good practice to set up both source and destination config when creating an endpoint. Now that we have our endpoint set we can use them in what we call our jobs. Make sure to click the ACTIVE checkmark otherwise we will not be able to use the endpoint when setting up our jobs.

To demonstrate how to set up another endpoint lets take a look at the one we will be using through this walkthrough we'll be using a Strapi endpoint to start lets take a look at what we need to enter for the configuration

-StrapiURL: This is the url that impulse will use to connect I am running a local version of strapi so my screenshot will be different but the principles are the same, the url that you need to connect impulse connects through a series of requests so we need these requests to go to strapi itself. For exmaple we will be adding the value "http://strapi-source:1337" -user: This is the user that you will login with to your strapi environment with permissions to edit content. -password: This is the user that you will login with to your strapi environment with permissions to edit content. -rateLimitperSecond: This is used to control the rate at which certain operations can be executed to prevent excessive usage or abuse of resources, this can be set at 7 this is the default rate limit for most endpoints and connectors.

For example this would be a standard endpoint set up: (loginUser and loginPassword are not required for this demo, the source and destination properties are the same for this demo)

in addition using this same principles we can add endpoint configuration to our Source endpoint from dotcms