Paragon
Search…
Triggering Workflows
Triggering workflows in Paragon
All Paragon workflows start with a trigger, which determines when the workflow will run and how data is passed into the workflow. Available workflow trigger types include:
  • ​App Event - triggered by an event sent from your application via the Paragon SDK or API
  • Webhook - triggered by an integration's webhook (ex. When a new contact is created in Salesforce)
  • Integration Enabled - triggered when your user initially activates your integration
  • Scheduler - runs automatically at a scheduled time or interval
In this section, we'll walk through common use cases for each trigger type and how you should use them.‌

App Events

App Events are custom events that are sent programmatically from your application via the Paragon SDK or API to trigger Workflows. In general, App Events are useful for triggering workflows that map data from your application to your users' apps.
For example, you might send a "Contact Created" App Event from your application to trigger a Workflow that creates a matching contact in your users' Salesforce CRM.
Once defined, an App Event can be used to trigger multiple workflows. This is useful in cases where you may want the same event to trigger similar workflows across different integrations.
For example, the same "Contact Created" event in the above example could trigger one workflow that creates a contact in Salesforce, and another workflow that creates a contact in HubSpot. This allows you to easily provide the same integration functionality across different providers without any additional engineering.

Creating an App Event

To create an App event, select the App Event trigger type in the Workflow editor and choose "Create new app event" in the menu under Choose an App Event.
Next, enter the name and event schema of your App Event. The event schema that you enter here should be an example payload sent from your application to Paragon. The event schema defined here will be used as test data for any workflows triggered by this App Event.
The event schema must be a valid JSON object, and can contain any arbitrary JSON.

Sending an App Event

App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:
  • name - the event name defined in your App Event
  • payload - the event payload that should match the event schema defined in your App Event
See the code examples below for how to send App Events using the Paragon SDK or API.
JavaScript SDK
REST API
1
var eventName = "Contact Created";
2
var eventPayload = { "name": "Brandon", "email": "[email protected]" };
3
4
// Called once during your user's session
5
paragon.authenticate("project-id", <Paragon User Token>)
6
7
// Trigger the "Contact Created" App Event
8
paragon.event(eventName, eventPayload)
Copied!
1
// Trigger the "Contact Created" App Event
2
POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger
3
4
Authorization: Bearer <Paragon User Token>
5
Content-Type: application/json
6
7
{
8
"name": "Contact Created",
9
"payload": {
10
"name": "Brandon",
11
"email": "[email protected]"
12
}
13
}
Copied!
When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Managing App Events

If you need to edit your App Events' name or event schema, you can visit the App Events tab in your Paragon dashboard to view and manage your app events.

Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' apps. For example, you might want to trigger a workflow whenever new contacts are created in your users' Salesforce account to sync your users' Salesforce contacts to your application in real-time.
You can find the full list of supported Webhook Triggers below. If you don't see the integration you're looking for, let us know and we'll be happy to add it to our roadmap if we're not already working on it.

Integration Enabled

Integration Enabled triggers can be used to run workflows when a user initially activates your integration. For example, you might want to trigger a workflow that syncs all leads from your customer's CRM to your application once they've enabled the integration.

Scheduler

The Scheduler trigger is used for workflows that should run automatically at a scheduled time or interval.
The Scheduler trigger provides the following scheduling options:‌
  • Seconds (e.g. every 5 seconds)
  • Minutes (e.g. every 30 minutes)
  • Hourly (e.g. every hour at 15 minutes past the hour)
  • Daily (e.g. every 2 days at 9:00 am)
  • Weekly (every Monday at 12:00 pm)
Once deployed, the workflow will run automatically at the designated time for all users who have activated the workflow in their Connect Portal.
Last modified 2mo ago