Skip to content

Latest commit

 

History

History
87 lines (70 loc) · 5.83 KB

EVENTS_API.md

File metadata and controls

87 lines (70 loc) · 5.83 KB

Interacting with the HackGreenville Events API

URLs and Query String Parameters

By default, results are returned in JSON format.

  • Get all upcoming events by calling /api/v0/events
  • Get events within a date range by calling /api/v0/events?start_date=2024-01-15&end_date=2024-02-01
    • the API defaults to providing only upcoming meetings, unless a start_date and end_date are specified
    • the API may only reply with a limited number of days in the past, as defined in the API's server configuration
    • "US/Eastern" is assumed as the timezone when a date filter is provided
  • Get events with a specific organizations tag by calling /api/v0/events?tags=1 - "tags" are applied to an organization in the organizations API. Currently, the organizations API only provides integer tag IDs, such as with this tag #1, representing OpenWorks hosted events, The format of the JSON that returns is:
  • The query parameters can be combined, so you could request only events for a specific tag, during a specific date range, like /api/v0/events?tags=1&start_date=2024-01-15&end_date=2024-02-01

Limitations and Gotchas

  • The Events API's responses are controlled by server .env variables that may limit the data available to calling / consuming applications. Contact HackGreenville Labs with any questions about these limits for the HackGreenville.com Events API endpoints referenced above.
  • All timestamps are in UTC.
  • The event description fields may include HTML markup. This application does not sanitize those fields and it's unclear if the upstream source should be trusted, so sanitize any output to avoid malicious cross-site scripting (XSS).
  • Previously, an Accept: application/json+ld header could be sent to the API to fetch Schema.org Event markup in JSON+LD format. However, this feature is not implemented in the newest version.

Sample JSON Event Object Response

{
	"event_name":"Calm Rails Upgrades",
	"group_name":"Upstate Ruby",
	"group_url":"https:\/\/twitter.com\/upstateruby",
	"url":"https:\/\/www.meetup.com\/upstate-ruby\/events\/298465949\/",
	"time":"2024-01-25T23:30:00.000000Z",
	"tags":1,
	"status":"upcoming",
	"rsvp_count":7,
	"description":"<p>Upgrading a Rails app can be daunting and stressful. Make your next Rails upgrade calm and oddly satisfying.<\/p> ",
	"uuid":"5fe306da6dc0df14fb6c182229d3ebe6",
	"data_as_of":"2024-01-23T18:49:52.738311Z",
	"service_id":"298465949",
	"service":"meetup",
	"venue":{
		"name":"OpenWorks",
		"address":"101 N Main St #302",
		"city":"Greenville",
		"state":"SC",
		"zip":"29601",
		"country":"us",
		"lat":"34.852020263672",
		"lon":"-82.399681091309"
	},
	"created_at":"2024-01-11T21:37:20.000000Z"
}

Contributor Notes

The following notes are specifically for contributors developing the Events API at app-modules/api/src/Http/Controllers/EventApiV0Controller.php.

Meetup.com

The Meetup GraphQL API is used to query events. This API requires a paid Meetup Pro account, the cost of which is covered by RefactorGVL.

The import code for this service exists in app-modules/event-importer/src/Services/MeetupRestHandler.php and schema of interest include groupByUrlname and Event.

Eventbrite

The import code for this service exists in app-modules/event-importer/src/Services/EventBriteHandler.php

Luma

The import code for this service exists in app-modules/event-importer/src/Services/LumaHandler.php

The Luma events for each org using the service are pulled via an public Luma URLs that are used to render the browser pages.

Kudos to Past Contributors

  • Thanks to @Nunie123 for the initial development, and to @ramona-spence for sustaining the previous Python implementation.
  • Thanks to @bogdankharchenko for migrating the Python implementation to PHP / Laravel

Archive

Meetup REST API