Home

Feeds

Feeds are a way to automatically pull event content from various sources into Localist for centralized management or export event content to other applications. This virtually eliminates duplicate entry, as any events entered in other systems will appear in Localist or vice versa with no additional work. At this time, Localist only accepts feeds of event data.

 

In this article you’ll find:

  • Importing Events
    • Feed Types
      • Data Comparision
    • Adding a Feed
      • Important Import Details
  • Exporting Events
    • Feed Types
      • ICS & RSS
      • Localist API: JSON & CSV
    • Additional Methods
      • Printing Your Calendar
      • Reverse Publishing
      • Content Embeds

 

Importing Feeds

Feed Types

These feeds are configured by Platform Admins directly in the Admin Dashboard.

  1. ICS — these feeds adhere to the iCalendar standard. ICS includes feeds from, but not limited to, iCal, Outlook, Exchange, Google Calendar, SideArm, Trumba, OrgSync and CollegiateLink.
  2. RSS — these feeds adhere to the hCalendar standard. Since RSS is inherently unstructured in terms of event dates, descriptions, etc., Localist needs specific tags to be able to successfully import. RSS includes feeds from, but not limited to, SimpleView and ActiveData.
  3. CSV — these feeds are CSV (.csv) or Excel (.xls) files hosted on your servers as a feed. The file must adhere to the same CSV format used for bulk uploading. CSV feeds also include, but are not limited to, Google Drive Sheets.
  4. Eventbrite — Localist will connect directly to Eventbrite through your admin dashboard for set up.
  5. EMS — events are imported through the EMS API.
  6. SeatGeek — events are imported through the SeatGeek API.

Data Comparison

 If a piece of Localist data is not imported, it is because the feed source does not provide that piece of data.
Data CSV ICS RSS EMS Eventbrite
Title
Description  ✓
Start Date  ✓  ✓  ✓
End Date  ✓  ✓
Start Time  ✓  ✓  ✓
End Time  ✓  ✓  ✓
Location  ✓  ✓*  ✓
Address
Room Number  ✓  ✓
URL  ✓  ✓
Event Types  ✓  ✓  ✓
Keywords  ✓
Tags  ✓
Photo URL  ✓
Ticket URL  ✓  ✓
Cost  ✓  ✓
Hashtag  ✓
Facebook URL  ✓
Group  ✓  ✓
Department  ✓
Allows Reviews  ✓
Visibility  ✓
Featured  ✓
Sponsored  ✓
Venue Page Only  ✓

*RSS Location must use proper hCal tags to be imported.

  • Non-hCal location: Event  at Location: <title>Senior Concert at Arts Center</title>
  • Location properly using hCal<span class=“location”>Arts Center</span>

Adding a Feed

1. Navigate to Events > Feeds

2. Select Add Feed

3. Select Feed Type

  • Your options are CSV/ICS/RSS or Eventbrite

4. Add Name and Feed URL

  • Note: The Name should be a general description for the feed. Ex. Women’s Soccer

5. Apply any rules

  • Skip Pending Queue: Events will go live directly to the platform at each import
  • Overwrite Schedule: If the date changes at the source, it will replace the current schedule in Localist.
    • If checked:  Event A on Oct 1 is imported —> Upon next import Event A is now listed for Oct 2 and Oct 1 is no longer present in the feed —> The live event in Localist is updated from Oct 1 to Oct 2
    • If not checked:  Event A on Oct 1 is imported —> Upon next import Event A is now listed for Oct 2 and Oct 1 is no longer present in the feed —> The live event in Localist is updated to now have two instances – both Oct 1 and Oct 2. Essentially, this functionality is only applied to instances of events that are still in the feed. If an entire event is remove from the feed then Localist will not make any updates or deletions and the event will stay in the last-imported state unless manually modified.
  • Don’t Update Filters: If checked, Content Overrides will only be applied upon the event’s first import. This means that you can apply a general override to the entire feed then apply specific filters on an individual basis without the Content Override replacing the specific filters after the next import.

6. Apply any Content Overrides (optional)

  • Note: If you apply a Content Override then you cannot apply more of the same filter type on an individual basis after import as they will be removed after the next import.

7. Add a photo to be assigned to all events in the feed (optional)

8. Add Authentication

  • If your feed requires an authenticated user to access it, enter the Username and Password.

 

Upon saving, the feed will initially import once. After the initial import, the feed will import once a day overnight. This time cannot be changed and updates will not be reflected in Localist until the nightly import. Note: Past events are not imported.

 

Feed Statuses:  After each import, the feed overview page will note the following details:

  • Status (complete, etc.)
  • Date and time of import
  • Number of events imported
  • Number of pending events
  • Number of rejected events

If an event has been rejected, there will be a link to see the exact errors per event.

 

Important Feed Import Details

Feed Data Takes Precedent

1. Data imported by a feed into Localist will always take precedent over data that has been added or updated in the Localist event. Only the following 3 details can be locked and cut off from further updating:

  • Name
  • Description
  • Event Place

2. All other details that are brought in via a feed must be changed at the feed source. If it is changed in any way in Localist then the changes will only stick until the next feed import, at which time it will revert back to the data in the feed.

  • Exception:  If a piece of data is not provided by the feed then any changes or additions in Localist will stick even after the next import. For example, if the feed only provides name/date/time/description/place then anything else, such as a tag or custom field, will remain as updated in Localist.

3. If fields in a feed match fields in Localist then the data must match exactly to what is saved in Localist. It is not possible to assign aliases or alternative spellings. For example, place names must match the place landing pages and filters must match your platform’s existing classification scheme in order to connect properly.

 

Deleting a Feed Event

1. Deleted in Localist:  If an event has been imported to the calendar then deleted, it will reappear if it is sent back over through the feed. Since feed data takes precedent, if the event is present in the feed then it will be re-added to Localist.

  • Exception:  If an event is rejected from the pending queue then it will not re-appear. If the event is deleted while still in the pending queue then it will be re-imported into the queue.

2. Deleted at the feed source:  If an event is removed from the feed source, the event in Localist will not be removed. This is because it is impossible for Localist to determine wether the event has been deleted/cancelled or if the event is just not present in the feed. In this case you will need to delete the instance in the feed and in Localist.

 

Exporting Events

Feed Types

  1. ICS & RSS — these feeds adhere to the iCalendar standard and hCalendar standard respectively and are available throughout the platform for automatic exporting via URLs. Localist provides specific Apple Cal, Google Cal and Outlook feeds to trigger each application when available.
  2. JSON — the Localist API provides all available event data in JSON.
  3. CSV — this can be generated through the Localist API and it will be a static file, not a feed.

 

ICS & RSS

Subscribed feeds cover 13 months: from 1 month ago to 1 year from now.

or

The first 1,000 events in that date range. For example, if there are 1,000 events in the first 6 months then the feed’s initial pull will only cover that date range.

  • Title
  • Date
  • Start time
  • End time (ICS only)
  • Description
  • Category  (Event Types in Localist)
  • Location (RSS appends this to the end of the title, such as Senior Concert at Arts Center)
  • Room Number (ICS only)

 

Where to find these feeds:

1. All Events or Filtered Results: All Localist platform has a built-in subscription box on every  filtered  results page (this is not available on the homepage). It is located to the right of the event listings and underneath the filters.

2. My Plans: A user can subscribe to only events that they’ve RSVP’d to via the I’m Going button.

3. Group or Place Landing Pages: When on the landing page, select View Full Calendar… then use the subscribe box displayed under the filters on the right side.

 

Google Calendar Notes:

  • Exporting Multiple Events — If exporting a filtered results page, Gmail will prompt you to add a new calendar.
  • Exporting Individual Events — If exporting from an individual event landing page, Gmail will open a regular Create form pre-populated with the available data. Note: If the event is recurring and includes several instances then Google will only add the first instance.

 

Outlook Notes:

There are some limitations placed on Outlook’s end that force exports to behave differently than iCal or RSS exports:

  • Outlook doesn’t allow subscribing to an ICS file with multiple events, such as a the filter results. Events will be added, but they will not be connected so the events won’t update to reflect future changes. If you copy the link to the ICS file and manually subscribe to it in Outlook then the events will be added and updated accordingly.
  • Windows Outlook handles importing an ICS file with one event in the ICS adds a single event to a calendar, but multiple events in the ICS as a new calendar. The ICS we generate for a single event always contains all instances of the event so it’s up to the calendar program how it’s imported.

 

Localist API: JSON & CSV

For terms of use, concepts and resources, Localist’s master API documentation can be found here: http://www.localist.com/doc/api

 

Basic Rules

  • Localist’s API is read-only and publicly accessible.
  • Calls will pull 10 items per page by default, but can be increased to up to 100 per page (this is well-above industry standard).
  • The maximum date range that the API call pull from is 370 days from today or the start date you specify.
  • If a start date is not specified, then the API will default to only pulling event data from today.

 

Building an API Call

All API calls must start with http://your.custom.domain/api/2/

  • Events: http://your.custom.domain/api/2/events
  • Places: http://your.custom.domain/api/2/places
  • Groups: http:/your.custom.domain/api/2/groups

Paging: http://your.custom.domain/api/2/events?type=38570&pp=100&page=1

  • This will pull 100 results per page so to access the next 100 you would change the 1 in page=1 to 2, etc.

Date Range:

  • Start and End date: http://your.custom.domain/api/2/events?type=38570&pp=100&page=1& start=2014-10-01&end=2014-11-01
  • Today + number of future days: http://your.custom.domain/api/2/events?days=90 (the maximum is 370 days).

 

Exporting to a CSV

1. Build an API call.

  • To pull a list of events you would use: http://yourcustomdomain/api/2/events?start=2014-09-01&end=2014-09-30&pp=100&page=1
  • This will pull 100 results per page so to access the next 100 you would change the1 in page=1to 2, etc.
  • Note: Events can be pulled from the start date + 370 days at a time.

2. Enter the API call in your search bar and you will see the data populate.

3. Open http://konklone.io/json/ in another tab.

4. Copy and paste all data that is on the API results page and paste that information in the first box on http://konklone.io/json/.

5. Once pasted, the information will be added to the second box in a table format.

6. Select Download the entire CSV and in this CSV you will have all available data for the first 100 events.

Additional Methods

Calendar Printing

Default (left) or custom print CSS (right)

To modify your platform’s print CSS, you will need to have the default Localist CSS open for your platform. This can be found here: https://customdomain.yourorganization.com/platform/stylesheet.css?expand=1 

The last section of the style sheet includes the default Localist print styles:

To modify these default print styles you can enter custom print CSS in your custom CSS box:

1. Navigate via Settings > Appearance

2. Select Customize next to Colors, Fonts & CSS

3. Enter @media print { and continue with your custom CSS comments. For example, the right hand column (mini cal/event types/etc)from print would be:

  • Example: @media print {.grid_4.omega { display: none; }}

 

Reverse Publishing

Localist can provide your event content in a format your pagination system supports in order to publish to print. Common Integrations:

  • InCopy
  • InDesign
  • NewsCycle Solutions

Data Formatting: Our reverse publishing mechanism is built on top of our API. So, all queries that are available in our API are available for reverse publishing. Essentially, you can make a call to the Localist API whenever you’re ready to start laying out the pages, and it will bring down the content you need.

  • Custom Formatting: In terms of the output format, we can change it to match the format you need for Indesign, InCopy or NewsCycle Solutions. Please send a sample data file of the format you need to support@localist.com and we can adapt our API to match.

 

Content Embeds

A widget enables you to create events once in Localist and publish everywhere with Widgets. Administrators and users can embed and display events or series of events on pages separate from the main calendar, such as the organization’s website homepage, partner organizations websites or other pages.

 

To learn more about widgets, please view our complete guide here.