Triggers

From the Management API perspective, triggers are configured by admin users as part of the campaign management process. Triggers are detected by end-user applications (API clients) with the goal of delivering relevant contextual content to be consumed by its users.

For a description of the triggers that can be configured, please refer to https://docs.actv8me.com/v1.2/docs/triggers-2

🚧

Triggerable Sources

Before you can create a trigger, you need to create a "triggerable" source. Please refer to the following links for the different type of sources that can be triggered:

• QR Code: https://docs.actv8me.com/v1.2/reference/qrcode
• Hyperlink: https://docs.actv8me.com/v1.2/reference/hyperlink
• Media: https://docs.actv8me.com/v1.2/reference/media
• Audio: https://docs.actv8me.com/v1.2/reference/audio
• Geofence: https://docs.actv8me.com/v1.2/reference/geofence
• Beacon: https://docs.actv8me.com/v1.2/reference/beacon

Create a Trigger

Once you have created a "triggerable" source, you can create a trigger that can be configured to deliver content. Use the following endpoint for that purpose:

POST /trigger

Reference: https://docs.actv8me.com/v1.2/reference/trigger#post_trigger

Update a Trigger

To update the configuration of a trigger, you may use the following endpoint:

PUT /trigger/{id}

Reference: https://docs.actv8me.com/v1.2/reference/trigger#put_trigger-id

Delete a Trigger

To delete a trigger, you may use the following endpoint:

DELETE /trigger/{id}

Reference: https://docs.actv8me.com/v1.2/reference/trigger#delete_trigger-id

Attach a Trigger to an Application

The content delivery process requires that a trigger is attached to the application that will be requesting content. You may use the following endpoint:

POST /trigger/{trigger_id}/application/{application_id}

https://docs.actv8me.com/v1.2/reference/trigger#post_trigger-trigger-id-application-application-id

Attach a Trigger to a Campaign

The content delivery process requires that a trigger is attached to a campaign. In order to do that, you may use the following endpoint:

PUT /campaign/{id}/trigger/{trigger_id}

Reference: https://docs.actv8me.com/v1.2/reference/campaign-3#put_campaign-id-trigger-trigger-id

Activate Trigger

Once the trigger is attached to the campaign, you need to make it "active" by calling the following endpoint:

PUT /campaign/{id}/trigger/{trigger_id}/activate

Reference:
https://docs.actv8me.com/v1.2/reference/campaign-3#put_campaign-id-trigger-trigger-id-activate

🚧

Although a trigger can be attached to several campaigns, it can only be active at one campaign at a time.

Deactivate Trigger

To deactivate a trigger in a campaign, your admin application should call the following endpoint:

PUT /campaign/{id}/trigger/{trigger_id}/deactivate

Reference:
https://docs.actv8me.com/v1.2/reference/campaign-3#put_campaign-id-trigger-trigger-id-deactivate