Defining the event and parameters: external event

The Wait for Event trigger can detect an event that occurs on a system that is external to HCL Commerce. You must implement a Process MarketingTriggers service call from the external system to inform the marketing services of the event. You can call this service a number of ways, by using a URL, Java code, or by calling the event REST API. The service call must pass the marketing services the name of your event and the parameters to match. Marketing managers need the event name and parameters from the service call to set up the Wait for Event trigger in the Management Center Marketing tool.

Procedure

  1. Define the Event name for the Wait for Event trigger.

    The Event name represents the event that starts or continues a Dialog activity that contains this trigger. Make up any name you want.

    For example, you might want to start a Dialog activity when an external system detects that fraud occurred for a certain customer's credit card. You could define an event name of CustomFraudDetectedTriggerEvent.
  2. Define the Parameter name for the Wait for Event trigger. Make up any name you want.

    The Parameter name is the name of a parameter in the service call that you want to match. The Wait for Event trigger can match one or two parameters.

    For example, you could define a parameter name of eventType.
  3. Optional: For each Parameter name, define the Parameter value to match. If necessary, you can define more than one Parameter value for each parameter. Make up any name you want.

    For example, for the eventType parameter, you could define a value of CreditCard.

    Note: The Parameter value is an optional field when setting up the Wait for Event trigger in the Management Center Marketing tool. If you want the Wait for Event trigger to match only the Event name and the Parameter name, do not provide parameter values to the marketing manager.
  4. Implement the Process MarketingTrigger service call from the external system by using either a URL, Java code, or by calling the event REST API.
    The service call must contain:
    • The DM_ReqCmd parameter with a value that is the Event name you defined in step 1.
    • Each Parameter name and Parameter value you defined in steps 2 and 3.

    For examples of how to implement the service call by using a URL or Java code, see the table in Ways to inform the marketing services of external or custom events for triggers and targets.

What to do next

Provide the Event name, the Parameter name, and (optionally) the Parameter value data for the Wait for Event Trigger to the marketing manager. In the Management Center Marketing tool, the marketing manager must enter this data in the properties view for the Wait for Event trigger used in a Dialog activity.