Form events
Events fired when a user completes an entry form or is awarded a prize.
Form SubmissionBeta
Beta
Raised when a user enters a competition form.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "CompetitionEntrySuccess", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well // Card "card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78", "card_name": "card name", "card_type": "Quiz", "score": "1", "correct": "1", "competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015", "submission_id": "c0ff823d-c8bf-4858-90b4-d536fe55b902", // Data capture fields "email": "joe@bloggs.com", "first_name": "Joe", "last_name": "Bloggs", "optin": "true",}| Name | Type | Description | Optional |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | False |
| event | String | An event name indicating the type of event that is being raised | False |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | False |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | False |
| site_name | String | The name of the given site. | False |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | False |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | True |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | True |
| card_id | GUID | The unique Id for the card. | False |
| card_name | String | The name of the card indicated by the internal name listed on the card. | False |
| card_type | String | The type of card that this event was triggered from. | False |
| score | Number | The total number of points for the gameplay. | False |
| correct | Number | The total number questions that the gameplay got correct. | False |
| competition_entry_id | GUID | The unique GUID identifier of an entry of a competition for a given card. | False |
| submission_id | GUID | A GUID identifier that uniquely identifies an instance of a data capture form submission. | False |
| Data capture fields | String | The fields that were attached to the form submitted. These will be added individually on the webhook body with the field's unique id as the key and the users response as the value. | False |
Prize AwardedBeta
Beta
Raised when a prize is awarded to a user for a given data capture.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "PrizeAwarded", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Card "card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78", "card_name": "card name", "card_type": "Quiz", "score": "1", "correct": "1", // Prize "prize_recipient_id": "39875c41-ab5b-44dd-9d2a-2818ba5acea3", "prize_id": "3c5f45f3-5b63-4365-94a3-1b4889b179a5", "prize_name": "First Prize", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well "competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015", "submission_id": "c0ff823d-c8bf-4858-90b4-d536fe55b902", // Data capture fields "email": "joe@bloggs.com", "first_name": "Joe", "last_name": "Bloggs", "optin": "true",}| Name | Type | Description | Optional |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | False |
| event | String | An event name indicating the type of event that is being raised | False |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | False |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | False |
| site_name | String | The name of the given site. | False |
| card_id | GUID | The unique Id for the card. | False |
| card_name | String | The name of the card indicated by the internal name listed on the card. | False |
| card_type | String | The type of card that this event was triggered from. | False |
| score | Number | The total number of points for the gameplay. | False |
| correct | Number | The total number questions that the gameplay got correct. | False |
| prize_recipient_id | GUID | A GUID identifier which uniquely identifies a prize recipient. | False |
| prize_id | GUID | A GUID identifier which uniquely identifies the prize. | False |
| prize_name | String | The name of the prize. | False |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | False |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | True |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | True |
| competition_entry_id | GUID | The unique GUID identifier of an entry of a competition for a given card. | False |
| submission_id | GUID | A GUID identifier that uniquely identifies an instance of a data capture form submission. | False |
| Data capture fields | String | The fields that were attached to the form submitted. These will be added individually on the webhook body with the field's unique id as the key and the users response as the value. | False |
Prize Form Submission SuccessComing soon
Coming soon
Raised when an prize form (presented after being awarded an instant win prize) is submitted. Typically these forms will ask for additional information like delivery address or shirt size to be able to deliver the prize to the user.
Example data
{ "id": "54e635de-92f5-4419-a498-5f69323db34c", "event": "PrizeFormSubmissionSuccess", "timestamp": "2000-01-01T00:00:00.000Z", // Site "site_id": "2d5776b8-158a-4216-aaa1-edbc249e005b", "site_name": "My site", // Card "card_id": "dd0b77cd-35ca-404e-8b23-1d86a7471f78", "card_name": "card name", "card_type": "Quiz", "score": "1", "correct": "1", // Prize "prize_recipient_id": "39875c41-ab5b-44dd-9d2a-2818ba5acea3", "prize_id": "3c5f45f3-5b63-4365-94a3-1b4889b179a5", "prize_name": "First Prize", // Session "user_session_id": "d40cc0e7-7243-4060-a75f-b2062c94462a", // User account (if accounts are enabled) "user_profile_id": "0fdbb943-511c-4220-9266-31465374f43b", // Any user attributes captured for the session/account will be added as well "competition_entry_id": "a76a65ea-6826-431a-938f-984f0abd0015", "submission_id": "c0ff823d-c8bf-4858-90b4-d536fe55b902", // Data capture fields "email": "joe@bloggs.com", "first_name": "Joe", "last_name": "Bloggs", "optin": "true",}| Name | Type | Description | Optional |
|---|---|---|---|
| id | GUID | A unique GUID identifier of the corresponding component | False |
| event | String | An event name indicating the type of event that is being raised | False |
| timestamp | TimeStamp | A timestamp indicating when the corresponding component was created | False |
| site_id | GUID | A GUID identifier which uniquely represents an active site. | False |
| site_name | String | The name of the given site. | False |
| card_id | GUID | The unique Id for the card. | False |
| card_name | String | The name of the card indicated by the internal name listed on the card. | False |
| card_type | String | The type of card that this event was triggered from. | False |
| score | Number | The total number of points for the gameplay. | False |
| correct | Number | The total number questions that the gameplay got correct. | False |
| prize_recipient_id | GUID | A GUID identifier which uniquely identifies a prize recipient. | False |
| prize_id | GUID | A GUID identifier which uniquely identifies the prize. | False |
| prize_name | String | The name of the prize. | False |
| user_session_id | GUID | A GUID identifier which uniquely represents an active user session. | False |
| user_profile_id | GUID | A GUID identifier which uniquely represents an active user profile. Only if profiles are enabled on the hub and the user has signed in | True |
| User attributes | String | If the user has a profile all attributes captured for their profile will be attached, if not any attributes captured for the user session will be included. Attributes will be listed as separate key value pairs on the webhook body. | True |
| competition_entry_id | GUID | The unique GUID identifier of an entry of a competition for a given card. | False |
| submission_id | GUID | A GUID identifier that uniquely identifies an instance of a data capture form submission. | False |
| Data capture fields | String | The fields that were attached to the form submitted. These will be added individually on the webhook body with the field's unique id as the key and the users response as the value. | False |
| Prize Form fields | String | A field attached to the prize form with an associated string value. An example is "shoe_size" as the corresponding form field with "M" as the prize field value. | True |