Actions

1 Fulfillment Actions
2 Webhooks
- 2.1 Webhook Setup
- 2.2 Webhook Payload
- 2.3 Previewing Webhook Payload

This is where you can trigger any number of actions. There are two types of triggers, Fulfillment Actions and Webhooks, for each Activation.

Fulfillment Actions

These Fulfillment Actions can be triggered from any of these events:

Automatic Drawing
Game Over
Leaderboard Points
Manual Drawing
Prize Won
Prize Not Won

Click the gear icon to set up a Fulfillment Action. One or more actions can be added depending on your goals.

Webhooks

Webhooks send a packet of information to an inbound webhook endpoint URL. Sending a webhook is just like opening a web page in your browser; however, it happens behind the scenes.

A common use case for calling a webhook after an activation is played is to send a player’s points to a 3rd party leaderboard. In this scenario, the activation can be iFramed into a web page or virtual event platform. One or more query string parameters can be dynamically added to the end of the iFrame URL and then forwarded on to the inbound webhook endpoint URL.

Webhook Setup

Here are a few things to note when setting up your webhook in the Activation Builder:

Use the +/- to add/remove one or more webhooks. Multiple webhooks can trigger simultaneously.
Choose to send our standard payload to your Endpoint URL or select one of our integrations to send a payload formatted for the integration partner.
Enter the Endpoint URL where you want us to send the payload. Make sure you have a script to parse the payload. This would be your inbound webhook URL.
Decide whether or not to include Prospect information (email, name, etc.) to adhere to your company’s privacy policy.

Webhook Payload

The code snippet below represents our standard webhook payload. Notice the webhook_var parameters. These parameters will be forwarded with the payload under the webhook_info object. As an example, when iFraming a game you could dynamically append a reg ID to the "webhook_var[abc]" query string parameter. As such, you might have webhook_var[UUID] as the parameter. This parameter will be forwarded back to your inbound webhook endpoint URL. Here's an example of embedding a game with an attendee that has a reg ID of 56: https://local-play.captello.com/Activations/loader/index.html?game=REARRANGE_WORDS&token=SKMq9wxebZrpwa4U1628010677&is_web_portal=0&webhook_var[UUID]=56

The "prospect_info" object is optional. In our web app you can flip a flag to not have this object sent in the payload.

Notice the game score is under the "activation_result" object.

{
  "id": "1",
  "timestamp": 1632054209,
  "team": {
    "id": "123",
    "name": "My Team"
  },
  "activation_info": {
    "activation_id": "123",
    "activation_name": "My ReArrange Words",
    "activation_identifier_id": "25",
    "activation_identifier_alias": "REARRANGE_WORDS",
    "activation_identifier_name": "Rearrange Words"
  },
  "activation_result": {
    "SCORE": 100,
    "DURATION": 0,
    "PRESENTS": [],
    "DONE": 0,
    "RIGHT": 0,
    "WINNER": 0
  },
  "webhook_info": {
    "webhook_var_val": "xyz",
    "webhook_var_regid": "mno",
    "webhook_var[abc]": "def",
    "webhook_var": "{\"regid\":\"123\",\"ticket\":[{\"id\":\"123\"},{\"name\":\"VIP\"}]}"
  },
  "prospect_info": {
    "Id": 12345,
    "Email": "john.smith@company.com",
    "FirstName": "John",
    "LastName": "Smith",
    "FullName": "John Smith"
  }
}

Previewing Webhook Payload

You can preview your Webhook payload by clicking on this eye icon which will open up the webhook payload in a right panel: