This article defines the different types of Trigger and Watchers that are available and describes how to set them up. The process is the same for each type of Connector.

Contents

• Overview
• Triggers
  • Basic Schedule Trigger
  • Advanced Schedule Trigger
    • Cron formatting
  • Webhook Triggers
  • Run Once Triggers
• Watchers
  • User Watchers
  • Webhook Watchers

Overview

From the Trigger stage, you can define Triggers and Watchers:

• Triggers enable you to define when a data feed is run.

• Watchers can be added to feeds to provide notifications of feed events to Peak users or other systems.

Triggers

Triggers enable you to define when a data feed is run. There are three types of Trigger:

• Schedule Trigger
  Schedule when the feed runs. A basic and advanced (cron) scheduler is available.

• Webhook Trigger
  Trigger a feed to run via a webhook from another system.

• Run Once Trigger
  Trigger the feed to run once at either a set time or manually from the feed list.

Basic Schedule Trigger

• Basic schedules use days and time.

• The feed will run on the selected days (blue).

• Enter a suitable time or frequency for your Peak organization.

Advanced Schedule Trigger

• Advanced schedules use cron.

• Enter the time / frequency as a cron string.

Cron formatting

A cron expression is a string comprising 6 or 7 fields separated by a space.

Cron expression examples:

Webhook Triggers

Webhook triggers are used to trigger a data feed when data on a separate system has been updated.

Webhooks work in a similar way to regular APIs, but rather than making constant requests to other systems to check for updates, webhooks will only send data when a particular event takes place; in this case when new data is available for the data feed.

Using a the Webhook URL

The Webhook URL is generated by Peak and is unique to the data feed that you are creating or editing. The data source system needs the URL so that it knows where to send the notification.

1. From the Trigger stage, click Webhook and copy the URL.
   If required, you can generate a new URL by clicking the curved arrow.

2. Use the URL in the webhook section of the application that you want to receive data from.
   If the system is external to Peak, you will also need to provide it with an API Key for your tenant so that the webhook can be authenticated.
   For more information about generating API Keys, see Setting up an API key.

3. Once you have generated and copied your Webhook URL, click SAVE.

Run Once Triggers

Run Once triggers are used to run the feed once at either a set time or manually from the feeds list.

From the Run Type drop-down menu, choose either:

• Manual
  This enables you to trigger the feed manually from the feeds list.
  To do this, go to Dock > Data Sources, hover over the feed and click Run now.
  For more information, see Data Sources overview.

• Date and Time
  The feed will run once at the scheduled date and time.
  The time you enter must be at least 30 minutes from the current time.

Watchers

Watchers can be added to feeds to provide notifications of feed events to Peak users or other systems.

There are two types of Watcher:

• User Watcher
  These are users of your organization that will receive a notification within the platform if a feed event occurs.

• Webhook Watcher
  These are used to trigger or send notifications to other systems or applications when a feed is updated.
  They could include external applications such as Slack or internal Peak functions such as Workflows.

To add a Watcher:

1. From the Trigger step screen, click ADD WATCHER.

2. Choose either User or Webhook.

User Watchers

These are users of your tenant that will receive a notification within the platform if a feed event occurs.

To choose a tenant user to add as a watcher:

1. Click the Search User dropdown.

2. Choose the data feed events that you want the user to be notified of.
   You can choose Watch All or a Custom selection.
   Once added, users can view notifications by clicking the bell icon at the top of the screen.

Data feed events

Users can be notified of the following data feed events:

• Create

• Execution status

• Run fail
  The feed run has failed.

• Edit / delete
  The feed has been edited or deleted.

• Run success
  The feed has successfully run.

• No new data
  There is no new data available on a feed.

Webhook Watchers

These are used to trigger or send notifications to other systems or applications when a feed is updated.
They could include external applications such as Slack or internal Peak functions such as Workflows.

The Webhook URL is taken from the application that you want to trigger if an event occurs.

If this is a Peak Workflow, this can be taken from the Workflow’s Trigger step.

The JSON payload is optional. It can be used to pass variables to provide additional information about the feed. Parameters can include:

• {tenantname}

• {jobtype}

• {jobname}

• {trigger}

Data feed events

Webhooks can be configured for the following data feed events:

• Run fail
  The feed run has failed.

• Run success
  The feed has successfully run.

• Running for more than x minutes
  The feed has been running for more than the specified time in minutes.

• No new data
  There is no new data available on a feed.