Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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

Info

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

...

Code Block
{
  "id": "1",
  "timestamp": 1632054209,
  "team": {
    "id": "123",
    "name": "My Team"
  },
  "activation_info": {
    "activation_id": "26123",
    "activation_name": "My ReArrange Words",
    "activation_identifier_id": "25",
    "activation_identifier_alias": "REARRANGE_WORDS",
    "activation_identifier_name": "Rearrange Words"
  },
  "activation_result": {
    "SCORE": -5100,
    "DURATION": 0,
    "PRESENTS": [],
    "DONE": 0,
    "RIGHT": 0,
    "WINNER": 0
  },
  "webhook_info": {
    "webhook_var[abc]_val": "xyz",
    "webhook_var[abc][s]": "e",
    "webhook_var[rst's]_regid": "yee'smno",
    "webhook_var[rst\"sabc]": "yee\def"s",
    "webhook_var": "{\"tttregid\":\"rrr123\",\"arrticket\":[{\"a1id\":\"v1123\"},{\"a2name\":\"v2VIP\"}]}"
  },
  "prospect_info": {
    "Id": 1131912345,
    "Email": "emadjohn.atya@leadliaisonsmith@company.com",
    "FirstName": "EmadJohn",
    "LastName": "AtteyaSmith",
    "FullName": "EmadJohn AtteyaSmith"
  }
}

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:

...