SPsponsorunited
Vortex

Create a scouting event from a Vortex session

Creates a new event and its report for the specified user. That user is recorded as the report's Captured By and is its first Assigned To. Authenticated via X-API-Key.

post/api/vortex/events

Request

Request body

user_idinteger required

ID of the user who captured the session. Recorded as the report's Captured By and used as its first Assigned To.

hometeam_idinteger required

ID of the home team / property

awayteam_idinteger nullable

ID of the away team (defaults to hometeam_id if omitted)

namestring required

Event name

event_type'season' | 'single' | 'multi' | 'social' required

Type of event

seasoninteger required

Season year (e.g. 2026)

scheduledstring date-time nullable

ISO 8601 scheduled datetime

venue_idinteger nullable

Venue ID

attended_datestring date-time nullable

When the scout was demonstrably on site — the earliest photo capture time. Falls back to scheduled when omitted.

captured_by_namestring nullable

Name of the person who captured the session, stored as text on the report next to captured_by. Sent for Vortex email-signup scouts, who have no user of their own and are pushed as a shared user, so captured_by alone cannot tell them apart. Recorded once when the report is created; never changed afterwards.

captured_by_emailstring nullable

Email of the person who captured the session, stored as text on the report next to captured_by. Same purpose and write-once rule as captured_by_name. Informational and stored as sent: it is not validated as an email address, so an address vortex-api accepted never fails the push.

Response

Event created successfully

idinteger
namestring
event_typestring
seasoninteger
hometeam_idinteger
awayteam_idinteger
scheduledstring date-time nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.