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
  • Scheduling
  • Scheduling Jobs
  • Creating a New Schedule
  • Updating an Existing Schedule
  • Scheduling Pipelines
  • Creating a New Schedule
  • Updating an Existing Schedule
  • Getting Schedules
  • Removing a Schedule
  1. Using Impulse Headlessly
  2. Getting Started with cURL

Scheduling Jobs and Pipelines

PreviousAutomating Jobs with PipelinesNextAligning Mismatched Content

Last updated 2 years ago

Scheduling

The takes cron expressions to create schedules for when to run both sync and pipeline transactions.

Scheduling Jobs

Creating a New Schedule

To create a new schedule for a job you can use the scheduler

To create a schedule for a job, you will need the job ID of the job you want to schedule and the cron expression for the schedule. This example creates a schedule that runs the job every minute.

curl --request POST '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/config' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cronregexp": "* * * * *",
  "jobid": "{{job-id}}"
}'

The response will provide the id of the newly created schedule config. You can save this ID to later update the config.

This endpoint can be used to create multiple schedules for the job.

Updating an Existing Schedule

To update an existing schedule you will need the schedule config ID, the job ID, and the cron expression for the schedule. This example updates the schedule to run the job every 5 minutes.

curl --request PUT '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/config/{{config-id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cronregexp": "*/5 * * * *",
  "jobid": "{{job-id}}"
}'

Scheduling Pipelines

Creating a New Schedule

To create a schedule for a pipeline, you will need the pipeline ID of the pipeline you want to schedule and the cron expression for the schedule. This example creates a schedule that runs the pipeline every minute.

curl --request POST '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/pipeline/config' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cronregexp": "* * * * *",
  "pipelineid": "{{pipeline-id}}"
}'

This endpoint can be used to create multiple schedules for the pipeline.

Updating an Existing Schedule

To update an existing schedule you will need the schedule config ID, the pipeline ID, and the cron expression for the schedule. This example updates the schedule to run the pipeline every 5 minutes.

curl --request PUT '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/pipeline/config/{{config-id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cronregexp": "*/5 * * * *",
  "pipelineid": "{{pipeline-id}}"
}'

Getting Schedules

You can get schedules either by ID or all the schedules at one time.

curl --request GET '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/config'

This will show all the schedules created both for job and pipelines.

curl --request GET '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/config/{{config-id}}'

This will show the single schedule for the passed in id.

Removing a Schedule

curl --request DELETE '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/scheduler/config/{{config-id}}'

This will remove the schedule so that it will no longer run.

To update an existing schedule you can use the scheduler's .

To create a new schedule for a pipeline you can use the scheduler .

To update an existing schedule you can use the scheduler's .

The scheduler's can be used to retrieve all schedules created.

The scheduler's can be used to retrieve a single schedule.

If you no longer want a schedule, you can remove it by using the .

scheduler
/sync/config endpoint.
/sync/config/{{config-id}} endpoint
/pipeline/config endpoint
/pipeline/config/{{configID}} endpoint
/config endpoint
/config/{{configID}} endpoint
/config/{{configID}} endpoint