Trigger Orchestrated campaigns using a signal trigger-signal
You can trigger an Orchestrated campaign by sending it a signal instead of running it on a schedule. The signal is sent via an API call from an external system or application. When using a signal, you can pass parameters. They are then made available in the orchestrated campaign as event variables in the execution context — for use in targeting, conditions, or expressions.
End-to-end process to trigger an Orchestrated campaign using a signal:
orchestrated-campaign.publish). See Built-in permissions.Schedule the campaign to be triggered by a signal configure-signal
To set an orchestrated campaign to start on a signal instead of a schedule, follow these steps:
-
Open the Orchestrated campaign you want to trigger using a signal.
-
Open the schedule configuration. Learn how to schedule an Orchestrated campaign.
-
Select Triggered by a signal so that the campaign waits for a signal instead of running on a schedule.
Add parameters for the signal payload (optional) parameters
You can pass parameters in the trigger signal and use them in your campaign in the execution context—for example, in targeting, conditions, or expressions. Define each parameter in the schedule settings first, then pass its value when you call the trigger API.
-
Open the campaign scheduler and select Add parameter.
-
Define each parameter’s name and data type to send in the signal payload. You can also provide Test values that will be used when you trigger the campaign in test mode. Learn how to test a triggered campaign.
Build and test the campaign build-and-test
Build your campaign on the canvas, then optionally test it in draft by triggering the signal via the API before you publish.
-
Add and connect activities (audience, targeting, deliveries) on the canvas. Learn how to orchestrate campaign activities
-
If you’ve defined parameters in the signal, you can wire them into your canvas logic (for example, in conditions or targeting). In this example, the “channel” parameter is used as a condition in a Test activity.
To use a signal parameter in the expression editor (for example, to build a query in a Build audience activity), type
$(vars/@<parameterName>)in the expression field. Replace<parameterName>with the parameter name defined in the scheduler—for example,$(vars/@channel). Learn how to work with the expression editor. -
Open the campaign scheduler, select Copy API request and choose the format (cURL or HTTP Request).
The copied information includes the orchestrated campaign ID, sandbox name, organization ID, and test values for your parameters if you have added some.
accordion Sample cURL request with a parameter and a test value code language-bash POST https://platform.adobe.io/ajo/campaign-orchestration/orchestratedCampaigns/1c7529c7-7a8c-491a-a2c6-3d8131d2e17d/trigger Headers: Authorization: Bearer ## Access token ## Content-Type: application/json x-api-key: ## Provide API Key here ## x-api-version: 1 x-gw-ims-org-id: 123456ABCDEFG@LumaOrg x-sandbox-name: prod Body: { "variables": { "channel": "sms" } } -
Click Start to start the campaign.
-
Send the trigger API call using the sample request you have copied from the scheduler.
When you are satisfied with the test results, publish the campaign.
Publish and trigger the campaign publish
After you have built and tested the campaign, publish the campaign so it can be triggered from your application.
-
Click Publish in the campaign canvas. The campaign must be published before it can be triggered from an external system. Learn more on starting and monitoring the campaign.
-
Open the campaign scheduler, select Copy API request and choose the format (cURL or HTTP Request).
The copied information includes the orchestrated campaign ID, sandbox name, organization ID, and parameters if you have added some.
-
Call the trigger API from your system.
note important IMPORTANT For a live orchestrated campaign, a throttle guardrail enforces a minimum interval of one hour between two API trigger executions. If you call the API again before that interval has elapsed, the API returns HTTP 429 error (Too many requests). This guardrail is not applied when you trigger a draft version to test it. If you added parameters to the signal payload, the values you pass in the API call are exposed as campaign event variables when the campaign runs. To inspect them, open the campaign logs from the campaign canvas toolbar. In the Tasks tab, identify the task corresponding to the signal and click the pencil icon to access the related event variables. Learn how to access logs and tasks.
