ON24
App · 25 actions
Run ON24 webinars from your workflows: create and copy webinars, register people, and read registrants, attendees, poll and survey results and leads, starting workflows when someone registers or attends.
Actions
| Action | What it does |
|---|---|
| Cancel registration | Cancel someone's registration for an event, found by their email. |
| Copy webinar | Copy a webinar to a new time, with its registration page, emails, slides, videos and tags; the copy is called 'Copy of' the original unless you give a title. |
| Create webinar | Create a webinar at a time you choose and get back its id and the links to share with the audience and presenters. |
| Delete webinar | Delete a webinar. |
| Get attendee by email | Get someone's most recent attendance by their email: what they watched, for how long, and what they did. |
| Get calls to action | Get an event's call-to-action buttons, where each leads and how often it was clicked. |
| Get engagement profile | Get someone's engagement profile by their email: their engagement level and totals across every event, interests and recent events. |
| Get event | Get one event with its times, audience and report links, and how many registered, attended live and watched on demand. |
| Get poll results | Get an event's polls, with how many voted and the share for each answer. |
| Get registrant by email | Get someone's most recent registration by their email, or their registration for one event. |
| Get resources viewed | Get an event's resources (documents and links for the audience), with how many downloaded each, and those nobody opened. |
| Get survey results | Get an event's surveys, with how many answered each question and the share for each answer. |
| List attendees (all events) | List everyone who attended any of the account's events in a date window (the last 30 days unless you give dates). |
| List event attendees | List everyone who attended one event, live or on demand, with minutes watched, engagement score, questions asked, polls and surveys answered and resources downloaded. |
| List event presenters | List who presented an event, in which role, and when they joined and left. |
| List event registrants | List everyone registered for one event with their details and registration id, filtered by date, email, partner reference or status. |
| List event types | List the kinds of webinar this account can create, with the value 'Create webinar' takes for each. |
| List events | List the account's webinars and other events in a date window (the last three months unless you give dates), with their times, links and audience totals. |
| List leads | List the account's leads (people who registered or attended) with their engagement level, interests and segments, in a date window (the last 30 days unless you give dates). |
| List registrants (all events) | List everyone who registered for any of the account's events in a date window (the last 30 days unless you give dates). |
| List registration fields | List the questions an event's registration page asks, with which are required and the choices a list offers. |
| List viewing sessions | List an event's viewing sessions: who watched, live or on demand, when and for how long. |
| Register attendee | Register someone for an event, as its registration page would, and get back their registration. |
| Update registrant | Change the registration details of someone registered for an event, found by their email, or block or unblock them. |
| Update webinar | Change a webinar's title, start time, length, time zone, summary or campaign code, or open or close its registration. |
Cancel registration
Cancel someone's registration for an event, found by their email. ON24 only allows it before the event starts.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Email
emailtextRequired - The email address they registered with.
Outputs
cancelledtrue/false- True once it is cancelled
emailtext- The email address cancelled
event_idnumber- The event's ON24 id
registrantobject- The registration as ON24 left it
Example output
{
"cancelled": true,
"email": "jo@example.com",
"event_id": 10432146,
"registrant": {
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
}Copy webinar
Copy a webinar to a new time, with its registration page, emails, slides, videos and tags; the copy is called 'Copy of' the original unless you give a title.
Inputs
- Webinar to copy
source_event_idtextRequired - The webinar to copy. Pick one, or give its id.
- Live start
live_startdate and timeRequired - When the live broadcast starts.
- Length
live_durationtextRequired - How long the live broadcast lasts.One of:
15(15 minutes),30(30 minutes),45(45 minutes),60(1 hour),75(1 hour 15 minutes),90(1 hour 30 minutes),105(1 hour 45 minutes),120(2 hours),150(2 hours 30 minutes),180(3 hours), and 10 more. - Title
titletext - A title for the copy, up to 250 characters.
- Time zone
time_zonetext - The time zone for the copy. Leave empty to keep the original's.
Outputs
eventobject- The copy as ON24 created it
event_idnumber- The copy's ON24 id
Example output
{
"event": {
"archiveEnd": "12/03/2027 10:30 AM",
"archiveStart": "12/03/2026 10:30 AM",
"audienceUrl": "https://event.on24.com/wcc/r/1418636/15545789BB2677BD0FB3F6FAA3F8B557",
"clientId": 22950,
"eventAbstract": "What shipped this quarter.",
"eventId": 1418636,
"eventType": "fav",
"goodAfter": "12/03/2026 08:45 AM",
"languageCd": "en",
"liveDuration": 3600,
"liveEnd": "12/03/2026 10:00 AM",
"liveStart": "12/03/2026 09:00 AM",
"previewUrl": "https://api.on24.com/webcast/previewlobby?e=1418636&k=93263D3E106F0243316315BE767D8550",
"promotionalSummary": "Join the product team live.",
"reportsUrl": "https://api.on24.com/webcast/report?e=1418636&k=93263D3E106F0243316315BE767D8550",
"timeZone": "America/Los_Angeles",
"title": "Q3 Product Update"
},
"event_id": 1418636
}Create webinar
Create a webinar at a time you choose and get back its id and the links to share with the audience and presenters.
Inputs
- Title
titletextRequired - The webinar's title, up to 250 characters.
- Live start
live_startdate and timeRequired - When the live broadcast starts.
- Length
live_durationtextRequired - How long the live broadcast lasts.One of:
15(15 minutes),30(30 minutes),45(45 minutes),60(1 hour),75(1 hour 15 minutes),90(1 hour 30 minutes),105(1 hour 45 minutes),120(2 hours),150(2 hours 30 minutes),180(3 hours), and 10 more. - Event type
event_typetextRequired - What kind of webinar it is, from your account's types.
- Language
languagetextRequired - The language of the audience's pages.
- Time zone
time_zonetextRequired - The time zone the webinar's times are shown in.
- Description
descriptiontext - What the webinar is about, shown to the audience.
- Promotional summary
promotional_summarytext - A short summary for promoting the webinar.
- Campaign code
campaign_codetext - Your campaign code, to match the webinar to a marketing campaign.
- Test webinar
test_eventtrue/false - Turn on to mark it as a test webinar.
Outputs
eventobject- The webinar as ON24 created it
event_idnumber- The new webinar's ON24 id
Example output
{
"event": {
"archiveEnd": "12/03/2027 10:30 AM",
"archiveStart": "12/03/2026 10:30 AM",
"audienceUrl": "https://event.on24.com/wcc/r/1418636/15545789BB2677BD0FB3F6FAA3F8B557",
"clientId": 22950,
"eventAbstract": "What shipped this quarter.",
"eventId": 1418636,
"eventType": "fav",
"goodAfter": "12/03/2026 08:45 AM",
"languageCd": "en",
"liveDuration": 3600,
"liveEnd": "12/03/2026 10:00 AM",
"liveStart": "12/03/2026 09:00 AM",
"previewUrl": "https://api.on24.com/webcast/previewlobby?e=1418636&k=93263D3E106F0243316315BE767D8550",
"promotionalSummary": "Join the product team live.",
"reportsUrl": "https://api.on24.com/webcast/report?e=1418636&k=93263D3E106F0243316315BE767D8550",
"timeZone": "America/Los_Angeles",
"title": "Q3 Product Update"
},
"event_id": 1418636
}Delete webinar
Delete a webinar. ON24 refuses to delete one that doesn't allow it.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- True once it is deleted
event_idnumber- The deleted webinar's ON24 id
messagetext- What ON24 said
Example output
{
"deleted": true,
"event_id": 1418636,
"message": "Event Successfully Deleted."
}Get attendee by email
Get someone's most recent attendance by their email: what they watched, for how long, and what they did.
Inputs
- Email
emailtextRequired - The person's email address.
Outputs
attendeeobject- The attendance
Example output
{
"attendee": {
"answeredpolls": 2,
"answeredsurveys": 1,
"archiveminutes": 12,
"askedquestions": 2,
"email": "jo@example.com",
"engagementscore": 8.5,
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstliveactivity": "2026-12-03T09:01:42-08:00",
"lastliveactivity": "2026-12-03T09:41:42-08:00",
"launchmode": "At the Venue",
"liveminutes": 40,
"partnerref": "newsletter",
"resourcesdownloaded": 1,
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active"
}
}Get calls to action
Get an event's call-to-action buttons, where each leads and how often it was clicked.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
calls_to_actionlist- The calls to action
countnumber- How many there are
event_idnumber- The event's ON24 id
Example output
{
"calls_to_action": [
{
"action": "https://www.example.com/demo",
"actiontype": "url",
"ctaid": 85411163,
"ctaname": "Book a demo",
"totalclicks": 11,
"uniqueclicks": 3
}
],
"count": 1,
"event_id": 10432146
}Get engagement profile
Get someone's engagement profile by their email: their engagement level and totals across every event, interests and recent events.
Inputs
- Email
emailtextRequired - The person's email address.
Outputs
profileobject- The engagement profile
Example output
{
"profile": {
"company": "Acme",
"email": "jo@example.com",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"lifetimeactivity": {
"engagementlevel": "HIGH",
"resources": 1,
"totalengagementminutes": 60,
"webinarsattended": 4
},
"recentactivities": [
{
"attendedarchive": "N",
"attendedlive": "Y",
"eventid": 10432146,
"eventtitle": "Q3 Product Update",
"registrationdate": "2026-11-12T10:05:23-08:00"
}
]
}
}Get event
Get one event with its times, audience and report links, and how many registered, attended live and watched on demand.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
eventobject- The event
Example output
{
"event": {
"archiveend": "2027-12-03T10:30:00-08:00",
"archivestart": "2026-12-03T10:30:00-08:00",
"audienceurl": "https://event.on24.com/wcc/r/10432146/9AB4ABD834D841E9E5ED9124D266848B",
"campaigncode": "Q3-UPDATE",
"clientid": 22950,
"contenttype": "webcast",
"createtimestamp": "2026-11-01T04:34:06-07:00",
"description": "Q3 Product Update",
"displaytimezonecd": "America/Los_Angeles",
"eventanalytics": {
"liveattendees": 6,
"noshowcount": 1,
"ondemandattendees": 3,
"totalattendees": 9,
"totalregistrants": 10
},
"eventid": 10432146,
"eventtype": "Live Video and Audio",
"goodafter": "2026-12-03T08:45:00-08:00",
"isactive": true,
"lastmodified": "2026-11-02T04:34:06-07:00",
"lastupdated": "2026-11-12T09:58:12-08:00",
"liveend": "2026-12-03T10:00:00-08:00",
"livestart": "2026-12-03T09:00:00-08:00",
"localelanguagecd": "en",
"previewurl": "https://event.on24.com/webcast/previewlobby?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237",
"regrequired": true,
"reporturl": "https://data.on24.com/webcast/report?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237",
"tags": [
"product",
"quarterly"
]
}
}Get poll results
Get an event's polls, with how many voted and the share for each answer.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many there are
event_idnumber- The event's ON24 id
pollslist- The polls
Example output
{
"count": 1,
"event_id": 10432146,
"polls": [
{
"pollid": 16818630,
"pollquestion": "How familiar are you with virtual events?",
"polltype": "singleoption",
"summary": [
{
"answer": "Very familiar",
"answercode": "choice1",
"percentage": 37.5
},
{
"answer": "Somewhat familiar",
"answercode": "choice2",
"percentage": 62.5
}
],
"totalvotes": 67
}
]
}Get registrant by email
Get someone's most recent registration by their email, or their registration for one event.
Inputs
- Email
emailtextRequired - The person's email address.
- Event
event_idtext - Only their registration for this event. Leave empty for their most recent.
Outputs
registrantobject- The registration
Example output
{
"registrant": {
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
}Get resources viewed
Get an event's resources (documents and links for the audience), with how many downloaded each, and those nobody opened.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
event_idnumber- The event's ON24 id
resources_not_viewedlist- Resources nobody opened
resources_viewedlist- Resources someone opened
totalnumber- How many resources the event has
Example output
{
"event_id": 10432146,
"resources_not_viewed": [
{
"resourceid": 183212528,
"resourcename": "Price list"
}
],
"resources_viewed": [
{
"resourceid": 183212518,
"resourcename": "Product brochure",
"totaldownloads": 7,
"uniquedownloads": 4
}
],
"total": 2
}Get survey results
Get an event's surveys, with how many answered each question and the share for each answer.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many there are
event_idnumber- The event's ON24 id
surveyslist- The surveys
Example output
{
"count": 1,
"event_id": 10432146,
"surveys": [
{
"surveycode": "survey1",
"surveyid": "10432146_survey1",
"surveyquestions": [
{
"question": "What industry are you in?",
"questionid": 6268271,
"questiontype": "singleoption",
"responses": 74
}
]
}
]
}List attendees (all events)
List everyone who attended any of the account's events in a date window (the last 30 days unless you give dates). Gets one page; to see more, run it again with the next page it gives.
Inputs
- Active from
start_datedate - Only those active on or after this date.
- Active until
end_datedate - Only those active on or before this date.
- Partner reference
partner_reftext - Only people who came in with this partner reference (the source code on the registration link).
- Leave out anonymous people
exclude_anonymoustrue/false - Turn on to leave out people with the made-up email addresses ON24 gives those who didn't register.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. ON24's default is 100.From 1 to 100.
Outputs
attendeeslist- The attendees
countnumber- How many are on this page
next_pagenumber- The page to read next, or 0 when this was the last
pagenumber- The page read, from 1
totalnumber- How many there are in all
Example output
{
"attendees": [
{
"answeredpolls": 2,
"answeredsurveys": 1,
"archiveminutes": 12,
"askedquestions": 2,
"email": "jo@example.com",
"engagementscore": 8.5,
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstliveactivity": "2026-12-03T09:01:42-08:00",
"lastliveactivity": "2026-12-03T09:41:42-08:00",
"launchmode": "At the Venue",
"liveminutes": 40,
"partnerref": "newsletter",
"resourcesdownloaded": 1,
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active"
}
],
"count": 1,
"next_page": 0,
"page": 1,
"total": 1
}List event attendees
List everyone who attended one event, live or on demand, with minutes watched, engagement score, questions asked, polls and surveys answered and resources downloaded.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Active from
start_datedate - Only those active on or after this date.
- Active until
end_datedate - Only those active on or before this date.
- Partner reference
partner_reftext - Only people who came in with this partner reference (the source code on the registration link).
- Leave out anonymous people
exclude_anonymoustrue/false - Turn on to leave out people with the made-up email addresses ON24 gives those who didn't register.
Outputs
attendeeslist- The attendees
countnumber- How many there are
event_idnumber- The event's ON24 id
totalnumber- How many ON24 counts in all
Example output
{
"attendees": [
{
"answeredpolls": 2,
"answeredsurveys": 1,
"archiveminutes": 12,
"askedquestions": 2,
"email": "jo@example.com",
"engagementscore": 8.5,
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstliveactivity": "2026-12-03T09:01:42-08:00",
"lastliveactivity": "2026-12-03T09:41:42-08:00",
"launchmode": "At the Venue",
"liveminutes": 40,
"partnerref": "newsletter",
"resourcesdownloaded": 1,
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active"
}
],
"count": 1,
"event_id": 10432146,
"total": 1
}List event presenters
List who presented an event, in which role, and when they joined and left.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many there are
event_idnumber- The event's ON24 id
presenterslist- The presenters
Example output
{
"count": 1,
"event_id": 10432146,
"presenters": [
{
"accessmode": "Producer",
"email": "sam@example.com",
"endtime": "2026-12-03T10:04:22-08:00",
"firstname": "Sam",
"ispracticesession": "N",
"lastname": "Lee",
"presenterid": 2009445,
"starttime": "2026-12-03T08:50:53-08:00"
}
]
}List event registrants
List everyone registered for one event with their details and registration id, filtered by date, email, partner reference or status.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Registered from
start_datedate - Only those registered on or after this date.
- Registered until
end_datedate - Only those registered on or before this date.
- Email
emailtext - Only the registrant with this email address.
- Partner reference
partner_reftext - Only people who came in with this partner reference (the source code on the registration link).
- Status
statustext - Which registrations to list. Leave empty for current registrations only.One of:
any(Everyone, including cancelled and forgotten),deleted(Cancelled registrations only),forgotten(Forgotten (personal data erased) only). - Only no-shows
no_shows_onlytrue/false - Turn on to list only people who registered but didn't attend.
- Leave out anonymous people
exclude_anonymoustrue/false - Turn on to leave out people with the made-up email addresses ON24 gives those who didn't register.
Outputs
countnumber- How many there are
event_idnumber- The event's ON24 id
registrantslist- The registrants
totalnumber- How many ON24 counts in all
Example output
{
"count": 1,
"event_id": 10432146,
"registrants": [
{
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
],
"total": 1
}List event types
List the kinds of webinar this account can create, with the value 'Create webinar' takes for each.
Inputs
None.
Outputs
countnumber- How many there are
event_typeslist- The event types
Example output
{
"count": 1,
"event_types": [
{
"label": "Live Video and Audio",
"value": "fav"
}
]
}List events
List the account's webinars and other events in a date window (the last three months unless you give dates), with their times, links and audience totals.
Inputs
- From
start_datedate - Only events on or after this date.
- Until
end_datedate - Only events on or before this date. At most six months after the start.
- Dates apply to
date_filtertext - Which of an event's dates the From and Until dates compare. Defaults to when the event is first available.One of:
goodafter(Available from (default)),creation(Created),modified(Details last changed),updated(Last audience activity),livestart(Live start),liveend(Live end),archivestart(On-demand start),archiveend(On-demand end). - Order
ordertext - Oldest or newest first. Defaults to oldest first.One of:
asc(Oldest first (default)),desc(Newest first). - Kind
content_typetext - Only this kind of content. Defaults to everything.One of:
all(Everything (default)),webcast(Webinars),forum(Forums),golive(Go Live events),gateway(Engagement Hub content),experience(Target experiences),video(Videos),pdf(Documents),webpage(Links). - Include inactive events
include_inactivetrue/false - Turn on to include events that are no longer active.
Outputs
countnumber- How many there are
eventslist- The events
totalnumber- How many ON24 counts in all
Example output
{
"count": 1,
"events": [
{
"archiveend": "2027-12-03T10:30:00-08:00",
"archivestart": "2026-12-03T10:30:00-08:00",
"audienceurl": "https://event.on24.com/wcc/r/10432146/9AB4ABD834D841E9E5ED9124D266848B",
"campaigncode": "Q3-UPDATE",
"clientid": 22950,
"contenttype": "webcast",
"createtimestamp": "2026-11-01T04:34:06-07:00",
"description": "Q3 Product Update",
"displaytimezonecd": "America/Los_Angeles",
"eventanalytics": {
"liveattendees": 6,
"noshowcount": 1,
"ondemandattendees": 3,
"totalattendees": 9,
"totalregistrants": 10
},
"eventid": 10432146,
"eventtype": "Live Video and Audio",
"goodafter": "2026-12-03T08:45:00-08:00",
"isactive": true,
"lastmodified": "2026-11-02T04:34:06-07:00",
"lastupdated": "2026-11-12T09:58:12-08:00",
"liveend": "2026-12-03T10:00:00-08:00",
"livestart": "2026-12-03T09:00:00-08:00",
"localelanguagecd": "en",
"previewurl": "https://event.on24.com/webcast/previewlobby?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237",
"regrequired": true,
"reporturl": "https://data.on24.com/webcast/report?e=10432146&k=A8EBCD7A76D8BF36D71DCFEBED688237",
"tags": [
"product",
"quarterly"
]
}
],
"total": 1
}List leads
List the account's leads (people who registered or attended) with their engagement level, interests and segments, in a date window (the last 30 days unless you give dates). Gets one page; to see more, run it again with the next page it gives.
Inputs
- Active from
start_datedate - Only leads active on or after this date.
- Active until
end_datedate - Only leads active on or before this date.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 50. ON24's default is 50.From 1 to 50.
Outputs
countnumber- How many are on this page
leadslist- The leads
next_pagenumber- The page to read next, or 0 when this was the last
pagenumber- The page read, from 1
totalnumber- How many there are in all
Example output
{
"count": 1,
"leads": [
{
"businessinterests": [
"webinars",
"analytics"
],
"email": "jo@example.com",
"engagementlevel": "HIGH",
"segments": [
"USA & Canada Users"
],
"userprofileurl": "https://data.on24.com/webcast/lead?token=yLw6HonT3FPP5"
}
],
"next_page": 0,
"page": 1,
"total": 1
}List registrants (all events)
List everyone who registered for any of the account's events in a date window (the last 30 days unless you give dates). Gets one page; to see more, run it again with the next page it gives.
Inputs
- Registered from
start_datedate - Only those registered on or after this date.
- Registered until
end_datedate - Only those registered on or before this date.
- Partner reference
partner_reftext - Only people who came in with this partner reference (the source code on the registration link).
- Leave out anonymous people
exclude_anonymoustrue/false - Turn on to leave out people with the made-up email addresses ON24 gives those who didn't register.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. ON24's default is 100.From 1 to 100.
Outputs
countnumber- How many are on this page
next_pagenumber- The page to read next, or 0 when this was the last
pagenumber- The page read, from 1
registrantslist- The registrants
totalnumber- How many there are in all
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"registrants": [
{
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
],
"total": 1
}List registration fields
List the questions an event's registration page asks, with which are required and the choices a list offers.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many there are
event_idnumber- The event's ON24 id
fieldslist- The registration fields
Example output
{
"count": 1,
"event_id": 10432146,
"fields": [
{
"fieldcaption": "Company",
"fieldid": "company",
"fieldtype": "textbox",
"required": "Y"
}
]
}List viewing sessions
List an event's viewing sessions: who watched, live or on demand, when and for how long. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Sessions
session_typetext - Which sessions to list. Defaults to all.One of:
all(All sessions (default)),live,ondemand(On demand),blocked. - From
start_datedate - Only sessions started on or after this date.
- Until
end_datedate - Only sessions on or before this date.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. ON24's default is 100.From 1 to 100.
Outputs
countnumber- How many are on this page
event_idnumber- The event's ON24 id
next_pagenumber- The page to read next, or 0 when this was the last
pagenumber- The page read, from 1
sessionslist- The viewing sessions
totalnumber- How many there are in all
Example output
{
"count": 1,
"event_id": 10432146,
"next_page": 0,
"page": 1,
"sessions": [
{
"duration": "00:38:13",
"email": "jo@example.com",
"endtime": "2026-12-03T09:39:55-08:00",
"firstname": "Jo",
"id": 150332406,
"lastname": "Bloggs",
"launchmode": "At the Venue",
"starttime": "2026-12-03T09:01:42-08:00",
"usage": "Live"
}
],
"total": 1
}Register attendee
Register someone for an event, as its registration page would, and get back their registration. Fill in every field the event's registration page requires ('List registration fields' shows them).
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Email
emailtextRequired - The person's email address.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Company
companytext - Their company.
- Job title
job_titletext - Their job title.
- Work phone
work_phonetext - Their work phone number.
- Street address
addresstext - Their street address.
- City
citytext - Their city.
- State or region
statetext - Their state or region.
- Postal code
zip_codetext - Their postal code.
- Country
countrytext - Their country.
- Partner reference
partner_reftext - The source code to record against them, as a registration link's partnerref would.
- Notes
notestext - Notes to keep with their registration.
- Skip required-field checks
skip_required_fieldstrue/false - Turn on to register them even if fields the registration page requires are missing.
Outputs
registrantobject- The registration
Example output
{
"registrant": {
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
}Update registrant
Change the registration details of someone registered for an event, found by their email, or block or unblock them. Only what you fill in changes.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Email
emailtextRequired - The email address they registered with.
- First name
first_nametext - Their first name.
- Last name
last_nametext - Their last name.
- Company
companytext - Their company.
- Job title
job_titletext - Their job title.
- Work phone
work_phonetext - Their work phone number.
- Street address
addresstext - Their street address.
- City
citytext - Their city.
- State or region
statetext - Their state or region.
- Postal code
zip_codetext - Their postal code.
- Country
countrytext - Their country.
- Partner reference
partner_reftext - The source code to record against them, as a registration link's partnerref would.
- Notes
notestext - Notes to keep with their registration.
- Blocked
blockedtrue/false - Turn on to block them from the event, or off to unblock them. Leave unset to keep it as it is.
Outputs
registrantobject- The registration
Example output
{
"registrant": {
"city": "Mountain View",
"company": "Acme",
"country": "United States",
"createtimestamp": "2026-11-12T10:05:23-08:00",
"email": "jo@example.com",
"eventid": 10432146,
"eventuserid": 150148905,
"exteventusercd": "ABC123",
"firstname": "Jo",
"jobtitle": "Marketing Manager",
"lastname": "Bloggs",
"partnerref": "newsletter",
"state": "CA",
"userprofileurl": "https://data.on24.com/webcast/lead?token=89vsUhobWeDdKMQ5",
"userstatus": "active",
"workphone": "(123)-456-7890",
"zip": "94040"
}
}Update webinar
Change a webinar's title, start time, length, time zone, summary or campaign code, or open or close its registration. Only what you fill in changes.
Inputs
- Event
event_idtextRequired - The event. Pick one, or give its id from an earlier step.
- Title
titletext - A new title, up to 250 characters.
- Live start
live_startdate and time - A new start time for the live broadcast.
- Length
live_durationtext - How long the live broadcast lasts.One of:
15(15 minutes),30(30 minutes),45(45 minutes),60(1 hour),75(1 hour 15 minutes),90(1 hour 30 minutes),105(1 hour 45 minutes),120(2 hours),150(2 hours 30 minutes),180(3 hours), and 10 more. - Time zone
time_zonetext - A new time zone to show the webinar's times in.
- Promotional summary
promotional_summarytext - A new promotional summary.
- Campaign code
campaign_codetext - A new campaign code.
- Registration open
registration_opentrue/false - Turn on to open registration, or off to close it. Leave unset to keep it as it is.
Outputs
eventobject- The webinar after the change
event_idnumber- The webinar's ON24 id
Example output
{
"event": {
"archiveEnd": "12/03/2027 10:30 AM",
"archiveStart": "12/03/2026 10:30 AM",
"audienceUrl": "https://event.on24.com/wcc/r/1418636/15545789BB2677BD0FB3F6FAA3F8B557",
"clientId": 22950,
"eventAbstract": "What shipped this quarter.",
"eventId": 1418636,
"eventType": "fav",
"goodAfter": "12/03/2026 08:45 AM",
"languageCd": "en",
"liveDuration": 3600,
"liveEnd": "12/03/2026 10:00 AM",
"liveStart": "12/03/2026 09:00 AM",
"previewUrl": "https://api.on24.com/webcast/previewlobby?e=1418636&k=93263D3E106F0243316315BE767D8550",
"promotionalSummary": "Join the product team live.",
"reportsUrl": "https://api.on24.com/webcast/report?e=1418636&k=93263D3E106F0243316315BE767D8550",
"timeZone": "America/Los_Angeles",
"title": "Q3 Product Update"
},
"event_id": 1418636
}