Skip to main content

Goldcast Webhooks Payload Structure

  • Updated

Overview

By using, Goldcast’s Webhooks Integration feature, you can send custom activities in Goldcast to any 3rd party system. Listed below are our 16 activities and their payload response structure which can be selected in your Goldcast account while configuring the integration for any event. 

  1. Registration
  2. Profile Updated
  3. Attended
  4. Q&A
  5. Resource Download
  6. Poll Response
  7. Event CTA Click
  8. Booth CTA Click
  9. Attended Discussion Group
  10. Attended Broadcast
  11. Attended Booth
  12. Event Engagement Score
  13. Time Spent in Broadcast
  14. Time Spent in Discussion Group
  15. Time Spent in Booth
  16. Event Engagement Time

 

NOTE : The payload structure for activities such as Registered, Attendance, and Profile Updated will vary based on the API names configured in your Goldcast Registration Forms. Ensure your configurations accommodate these changes.

 

1. Registration

{
"lastName":"Desai",
"activityType":"REGISTRATION",
"linkedinUrl":"https://www.linkedin.com/in/piyush-desai/",
"eventId":"b77743e2-d5c6-4205897a2e9a",
"title":"PM intern",
"firstName":"Piyush",
"twitterUrl":"https://www.twitter.com/piyush-desai/",
"activityTime":16940055,
"company":"GC",
"userId":"6a4e95e3-0ee4b3a2edb8",
"email":"piyushdesai7777@gmail.com",
"magicLinkUrl":"https://events.goldcast.io/auth/link/piyushdesai7777@gmail.com?eventID=b77743e2-d5c6-4001-9c2d&shortId=2640",
"props":{
"accessiblity":"none",
"customFieldNumber":83263272,
"street_address":"Street 1522",
"country":"US",
"customPasswordField":"",
"city":"Sitka",
"utm_medium":"website",
"industry":"Computer Software/Engineering",
"customFieldCheckbox":true,
"utm_region":"emea",
"zip_code":"560102",
"dietary_restrictions":"vegetarian:",
"visa_required":true,
"customFieldDay":"02/11/1999",
"address_line_2":"Adjacent to Highway 54",
"state":"AK",
"utm_creative":"creativecampaign",
"customFieldTags":"customtag1,customtag2,customtag3",
"utm_content":"contentlab",
"registrant_type":"event staff",
"utm_campaign":"dnbfunnel",
"customFieldDateTime":"2023-09-06T12:00:00+05:30",
"customHiddenField":null,
"customFieldTextArea":"This is custom field that is of type Text Area, 
the payload strucutre in your webhook will change according to the API names 
you name for your fields in your Goldcast forms",
"data_share_consent":true,
"customSelectBoxes":{
"selectBox1":true,
"selectBox2":false,
"selectBox3":true,
"selectBox4":false
},
"customFieldTime":"21:33:00",
"utm_keyword":"seocontent",
"customFieldUrl":"https://www.google.com/travel/",
"utm_term":"term",
"customFieldRadio":"nota",
"phone_number":"(738) 752-6211",
"pronouns":"He/Him",
"customFieldSelect":"select1",
"age":24,
"utm_source":"facebook",
"customtextField":"Custom Value for your Text Field"
}
}

2. Profile Updated

{
  "lastName": "Desai",
  "activityType": "PROFILE_UPDATED",
  "eventId": "3567cc9d-b125-4hdgs672jc",
  "location": null,
  "title": "Chef",
  "tags": [
    "tag1"
  ],
  "firstName": "Piyush",
  "activityTime": 1638339602,
  "company": "Goldcast",
  "userId": "a33b5a9a-fdfb-7d4ed814cf5f",
  "email": "piyushdesai7777@gmail.com",
  "twitterUrl": "https://www.twitter.com/piyushdesai/",
  "linkedinUrl": "https://www.linkedin.com/in/piyushdesai1234/"
}

 

3. Attended

{
"activityType":"ATTENDED",
"activityTime":1694005782,
"eventId":"b77743e2-9c2d-4205897a2e9a",
"firstName":"Piyush",
"lastName":"Desai",
"title":"PM intern",
"email":"piyushdesai7777@gmail.com",
"engagementType":"Live",
"props":{
"age":24,
"city":"Sitka",
"state":"AK",
"country":"US",
"industry":"Computer Software/Engineering",
"pronouns":"He/Him",
"utm_term":"term",
"zip_code":"560102",
"utm_medium":"website",
"utm_region":"emea",
"utm_source":"facebook",
"utm_content":"contentlab",
"utm_keyword":"seocontent",
"accessiblity":"none",
"phone_number":"(738) 752-6211",
"utm_campaign":"dnbfunnel",
"utm_creative":"creativecampaign",
"visa_required":true,
"address_line_2":"Adjacent to Highway 54",
"customFieldDay":"02/11/1999",
"customFieldUrl":"https://www.google.com/travel/",
"street_address":"Street 1522",
"customFieldTags":"customtag1,customtag2,customtag3",
"customFieldTime":"21:33:00",
"customtextField":"Custom Value for your Text Field",
"registrant_type":"event staff",
"customFieldRadio":"nota",
"customFieldNumber":83263272,
"customFieldSelect":"select1",
"customHiddenField":null,
"customSelectBoxes":{
"selectBox1":true,
"selectBox2":false,
"selectBox3":true,
"selectBox4":false
},
"data_share_consent":true,
"customFieldCheckbox":true,
"customFieldDateTime":"2023-09-06T12:00:00+05:30",
"customFieldTextArea":"This is custom field that is of type Text Area,
 the payload strucutre in your webhook will change according to the API names
 you name for your fields in your Goldcast forms",
"customPasswordField":"Password123",
"dietary_restrictions":"vegetarian:"
},
"userId":"6a4e95e3-a4a8-0ee4b3a2edb8",
"company":"GC",
"twitterUrl":"https://www.twitter.com/piyush-desai/",
"linkedinUrl":"https://www.linkedin.com/in/piyush-desai/"
}

 

4. Q&A

{
  "activityType": "QNA",
  "activityTime": 16781986,
  "eventId": "7772c9e-4a0e-8cfd-34852d362262",
  "qnaIsAnswered": false,
  "title": "Product Management Director",
  "userId": "4a6b9169-8af4-1e67a984a2a7",
  "email": "ilyas@goldcast.io",
  "firstName": "Ilyaas",
  "lastName": "Khawaja",
  "qnaQuestion": "How are pacing on the Q1 goals for the Studio Tribe?",
  "broadcastId": "e473f2bd-4383-aa39-c04daee3f7da"
}

 

5. Resource Download

{
  "activityType": "RESOURCE_DOWNLOAD",
  "activityTime": 18194736,
  "eventId": "7772c9ea-07e5-4a0e-34852d362262",
  "resourceLink": "https://docs.google.com/presentation/d/1VEacRYUTn0TWFD7/edit",
  "title": "Product",
  "userId": "75d063fb-48a7-4703-bd33-7e2b1cb",
  "email": "piyushdesai@goldcast.io",
  "firstName": "Piyush",
  "lastName": "D.",
  "resourceName": "Sprint 65 Deck",
  "sessionId": "e473f2bd-824b-43839-c04daee3f7da",
  "sessionTitle": "Sprint demo",
  "sessionType": "broadcast"
}

 

6. Poll Response

{
"activityType": "POLL_RESPONSE",
"activityTime": 16645696,
"eventId": "d152ec56-b1ea-a847-0974daa0f4d6",
"pollQuestion": "What are the best ways to get the audience HOOKED?",
"pollAnswer": "Get HOOKED by Nir Eyal”,
"title": "Product Manager",
"userId": "080f00ad-4b44-9fbb-19596c4a91a2",
"email": "piyushdesai@goldcast.io",
"firstName": "Piyush",
"lastName": "Desai",
"broadcastId": "080f00ad-4b44-9fbb-19596c1291a2"
}

 

7. Event CTA Click

{
  "activityType": "EVENT_CTA_CLICKS",
  "activityTime": 16781746,
  "eventId": "7772c9ea-4a0e-8cfd-34852d",
  "title": "Product",
  "userId": "75d063fb-4703-bd33-7ea227",
  "firstName": "Piyush",
  "lastName": "D.",
  "email": "piyushdesai@goldcast.io",
  "ctaButtonText": "Request a Demo",
  "ctaConfirmationTitle": "DEMO REQUEST SENT",
  "ctaConfirmationMessage": "Your request was successfully saved. Thanks for requesting a demo with us."
}

 

8. Booth CTA Click

{
"activityType": "BOOTH_CTA_CLICKS",
"activityTime": 1646184,
"eventId": "d152ec56-471e-a847-0974daa0f4d6",
"title": "QA ENGINEER",
"userId": "12b88b84-7bc6-4e1d-17706d53d9c8",
"firstName": "Bazil",
"lastName": "Sarosh",
"email": "bazilsarosh@gmail.com",
"ctaButtonText": "Click here to know more",
"ctaConfirmationTitle": "VIOLA",
"ctaConfirmationMessage": "You have been added to mailers list",
"boothId": "def8b-44c9-b860-ab7d4b29ebfd",
"boothName": "How to raise VC funds?"
}

 

9. Attended Discussion Group

{
  "activityType": "ATTENDED_DISCUSSION_GROUP",
  "activityTime": 16781902,
  "eventId": "7772c9ea-07e5-8cfd-34852d362262",
  "title": "Software Engineer",
  "userId": "33f14bf6-7940-9822-75259501e490",
  "firstName": "Nishant",
  "lastName": "Parashar",
  "email": "nishantt@goldcast.io",
  "sessionId": "d100a6ec-aa82-b0b4-f127b2c9ac93",
  "sessionName": "FIFA World Cup Semis Predictions",
  "sessionEntryTimestamp": "16781102463"
}

 

10. Attended Broadcast

{
  "activityType": "ATTENDED_BROADCAST",
  "activityTime": 16781947,
  "eventId": "7772c9ea-07e5-8cfd-34852d362262",
  "title": "Product Manager",
  "userId": "8744d7d6-e904-9b24-050834421a11",
  "firstName": "Bhavik",
  "lastName": "Jain",
  "email": "bhavik@goldcast.io",
  "sessionId": "e473f2bd-4383-aa39-c04daee3f7da",
  "sessionName": "Sprint demo",
  "sessionEntryTimestamp": "164156979"
}

 

11. Attended Booth

{
"activityType": "ATTENDED_BOOTH",
"activityTime": 16646181,
"eventId": "d152ec56-471e-a847-0974daa0f4d6",
"title": "QA ENGINEER",
"userId": "1284-7bc6-4e1d-9004-17706d53d9c8",
"firstName": "Bazil",
"lastName": "Sarosh",
"email": "bazilsarosh@gmail.com",
"sessionId": "def8ff5b-44c9-4f01-b860-ab7d4b29ebfd",
"sessionName": "How to raise VC funds?",
"sessionEntryTimestamp": "16546180736"
}

 

12. Event Engagement Score

{
"activityType": "ENGAGEMENT_SCORE",
"activityTime": 165696,
"eventId": "d152ec56-a847-0974daa0f4d6",
"engagementPercentile": 5,
"title": "Performance Marketing",
"userId": "08ad-ee26--9fbb-19596c4a91a2",
"email": "bazil@goldcast.io",
"firstName": "Bazil",
"lastName": "Sarosh"
}

 

13. Time Spent in Broadcast

{
"activityType": "TIME_SPENT_IN_BROADCAST",
"activityTime": 16565992,
"eventId": "d152ec56-471e-a847-0974daa0f4d6",
"broadcastTimespent": 16.9,
"title": "SOFTWARE ENGINEER",
"userId": "12b88b84-7bc6-9004-17706d53d9c8",
"email": "nikhilChandwani@gmail.com",
"firstName": "Nikhil",
"lastName": "Chandwani",
"broadcastId": "080f00ad-ee26-9fbb-19596c4a91a2",
“broadcastName”: "Sprint Demo Session",
"engagementType": "Live"
}

 

14. Time Spent in Discussion Group

{
"activityType": "TIME_SPENT_IN_DISCUSSION_GROUP",
"activityTime": 16645592,
"eventId": "d152ec56-b1ea-471e-0974daa0f4d6",
"dgTimespent": 20,
"title": "SOFTWARE ENGINEER",
"userId": "12b88b84-7bc6-9004-17706d53d9c8",
"email": "nikhilChandwani@gmail.com",
"firstName": "Nikhil",
"lastName": "Chandwani",
"discussionGroupId": "080f00ad-4b44-9fbb-19596c4a91a2", “discussionGroupName”:"Round Table Event Conference" 
}

 

15. Time Spent in Booth

{
"activityType": "TIME_SPENT_IN_BOOTH",
"activityTime": 1565992,
"eventId": "d152ec56-471e-a847-0974daa0f4d6",
"boothTimespent": 16.9,
"title": " SOFTWARE ENGINEER",
"userId": "12b88b84-9004-17706d53d9c8",
"email": "nikhilChandwani@gmail.com",
"firstName": "Nikhil",
"lastName": "Chandwani",
"boothId": "080f00ad-9fbb-19596c4a91a2",
“boothName”: "Mercedes - Get your Own Brochure now"
}

 

16. Event Engagement Time

{
"activityType": "TIME_SPENT_IN_EVENT",
"activityTime": 16565992,
"eventId": "d152ec56-471e-a847-0974daa0f4d6",
"eventTimespent": 34.0,
"title": "QA ENGINEER",
"userId": "12b88b84-4e1d-9004-17706d53d9c8",
"email": "bazilsarosh@gmail.com",
"firstName": "Bazil",
"lastName": "Sarosh"
}

Related articles