Hopin

The Hopin Ads Connector provides automated access to the Hopin API

The connector iterates over all the organizations and events to which your credentials provide access using the API (unless it is specifically indicated to skip over them).

Prerequisites

API Key
A user-unique API key that will be provided to you by Hopin

Scheduling

The Hopin Ads connector can be scheduled to ingest data once per day at a user-defined hour and timezone.

By default, the connector will run once at 6am PT.

See Daily Scheduling for more information.

Parameters

project_name string
required
name of the project to which the download is performed. Could be any value.
skip_organization_ids list of strings
optional
identifier of an organization to skip when iterating over data
skip_event_ids list of strings
optional
identifier of an event to skip over when iterating over data

Sample Switchboard Script

download bundle hopin_api_bundle {
    type: "hopin:event_bundle";
    key: "XX";
    skip_organization_ids: []; 
    skip_event_ids: [];
    project_name: ""; // name of the project to which the download is performed. Could be any value.
    table organizations 
        using {
            "id": string;
            "name": string;
            "email": string;
            "website": string;
            "facebook": string;
            "twitter": string;
            "createdAt": datetime("YYYY-MM-dd'T'HH:mm:ss.SSSZ"); //2021-09-18T18:00:00.000Z
};
    
    table events
        using {
            "id": string;
            "slug": string;
            "name": string;
            "description": string;
            "timezone": string;
            "timeStart": datetime("YYYY-MM-dd'T'HH:mm:ss.SSSZ"); //2021-09-18T18:00:00.000Z
            "timeEnd": datetime("YYYY-MM-dd'T'HH:mm:ss.SSSZ");
            "createdAt": datetime("YYYY-MM-dd'T'HH:mm:ss.SSSZ");
            "type":  string;
            "published": boolean;
    };
    
    table registrations 
        using {
            "email": string;
            "first_name": string;
            "last_name": string;
            "headline": string;
            "country": string;
            "ticket": string;
            "promo_code": string;
            "refunded": string;
            "purchase_price_usd": float;
            "promo_value_usd": float;
            "refund_amount_usd": float;
            "affiliate_name": string;
            "registration_source": string;
            "registration_date": datetime("YYYY-MM-dd'T'HH:mm:ssZ"); 
            "event_id": string;
    };
    
    table participation 
        using {
        "email": string;
        "name": string;
        "headline": string;
        "location": string;
        "ticket": string;
        "minutes_spent": integer;
        "registered_at": datetime("YYYY-MM-dd'T'HH:mm:ssZ"); 
        "purchase_price(USD)": float;
        "registration_source": string;
        "affiliate_name": string;
        "event_id":  string;
        "Position": string;
        "Company": string;
        "City": string;
        "State/Province": string;
        "Zip/Postal Code": string;
        "Country/Region": string;
};
    
    table attendeeActivity 
        using {
            "StartTime": datetime("YYYY-MM-dd HH:mm:ss z"); // 2021-09-08 14:22:11 UTC
            "EndTime": datetime("YYYY-MM-dd HH:mm:ss z");
            "MinutesSpent": integer;
            "Email": string;
            "FullName": string;
            "Headline": string;
            "TicketType": string; 
            "Area": string;
            "Subarea": string;
            "Schedule": string;
           "event_id": string;
        };
                
};