Rise.ai logo

Custom Triggers

Enterprise Plan OnlyThis feature is exclusively available for stores on the Rise Enterprise plan.
What You'll Find HereThe Custom Triggers feature allows your Rise store-credit workflows to be activated by external events you configure. With this API-based system, you can automatically reward your customers with store credit for virtually any activity.
What are Custom Triggers?While Built-in Triggers are defined by Rise's pre-built events and integrations, Custom Triggers are activated through an external system or API. To use them successfully, you build a trigger workflow in Rise and then connect it to your external system to activate the workflow exactly when you need it.
Examples of Custom Trigger Use CasesThe possibilities are endless! Common examples include:
• Birthdays: Automatically reward customers with store credit on their birthday.• Newsletter sign-ups: Issue credit when a customer subscribes to your mailing list.• Form completions: Reward customers for filling out surveys or feedback forms.• Win-back campaigns: Re-engage lapsed customers with a store-credit incentive.• Cart abandonment campaigns: Offer credit to customers who left items in their cart.• Recycling rewards: Issue credit when a customer completes a recycling action.
How to Build a Custom TriggerWorkflows in our system are composed of a Trigger, Conditions, and an Action (our primary action is issuing store credit). Follow these steps to set up your custom trigger.

Setup Overview

1.
Step 1: Create the Trigger in the Rise DashboardDefine the trigger name, key, and payload schema inside the Rise platform.
2.
Step 2: Validate Your PayloadEnsure your payload includes a field with format = email and that all numbers use type string with format number.
3.
Step 3: Activate via APISend a POST request to the Rise API with your trigger key and payload to fire the workflow.
Step 1: Create the Trigger in the Rise Dashboard
• Navigate: Go to Developer Tools > Custom Triggers in your Rise platform dashboard.• Create: Click the + Create Custom Trigger button.• Display Name: A recognizable name for your trigger (e.g., Order Completed).• Trigger Key: A unique identifier used when triggering via the API (e.g., order_completed).• Sample Payload: Add an example JSON payload with the fields you expect to send and realistic sample values. Rise will infer the schema from that payload.
Default Setup: Generate Schema from PayloadThe default setup flow starts from a sample payload. Paste an example of the JSON you plan to send, including the expected fields and sample values, and the system will understand the schema for you. If you want full manual control, click Modify JSON schema to edit the schema directly and adjust details like field formats, required fields, and more advanced rules.
Step 2: Payload RequirementsTo ensure the workflow can correctly issue store credit, your payload data must adhere to the following rules:
• Email Field: The trigger payload must include a field with format = email. This dictates which customer's wallet will receive the store credit.• Number Fields: Any numbers passed in the payload must be configured as type string with format number.
Step 3: Activating the Custom TriggerOnce your trigger is created, you can activate it by sending a POST request to the Rise API.
API Request SetupUse the following cURL command to call your custom trigger. Replace the placeholder variables with your actual ACCOUNT_ID, API_KEY, triggerKey, and payload data.
curl -X POST 'https://platform.rise.ai/workflows/v1/events/report' \
  -H 'Content-Type: application/json' \
  -H 'rise-account-id: $ACCOUNT_ID' \
  -H 'Authorization: $API_KEY' \
  -d '{
    "triggerKey": "your_unique_trigger_key",
    "payload": {
      SOME_PAYLOAD_FIELD: "value",
    }
  }'
Understanding the API ResponseImportant: The API operates asynchronously. If you receive a 200 OK response, it means the trigger is valid and the workflow has been successfully initiated. However, it does not mean the credit has been issued instantly — it simply confirms the workflow is currently running in the background.
Using Custom Triggers in Code and Other AppsYou can trigger this workflow from your own code or from automation tools and external apps. In every case, you send the trigger key together with a payload that matches the structure you defined in Rise, and authenticate the request with your Rise account ID and API key.From code, this usually means sending a server-side POST request to the Rise endpoint whenever the event happens in your system. From tools like Shopify Flow or Klaviyo, you can usually configure a webhook or HTTP request action, point it to the Rise endpoint, include the same JSON payload fields, and add your API credentials in the request headers. This lets those tools trigger the same Rise workflow without custom backend logic.

Usage Options

1.
1. Define the payload in RiseCreate the custom trigger using a sample payload that matches the fields your code or app will send.
2.
2. Configure the requestFrom your backend, Shopify Flow, Klaviyo, or another app, send a POST request with the trigger key and payload JSON.
3.
3. Add authenticationInclude your Rise account ID and API key in the request headers so Rise can validate and process the trigger.
Integration TipWhen setting up Shopify Flow, Klaviyo, or another automation tool, make sure the payload fields line up with the schema generated in Rise. If you later need stricter validation or custom field settings, use Modify JSON schema to refine the schema manually.