Setup

1. Load Aiera's client library into your HTML page using "<script />" tag
Copy

<script src="https://dashboard.aiera.com/static/integration/aiera.0b07707e.js"></script>

2. Call into the library passing the following arguments:
Copy

var aiera = Aiera.loadEventFrame({
  apiKey: ‘123456abcdef’,
  eventId: 1234567, // the Aiera event id
  userId: 1234567, // id to uniquely identify a user in YOUR system
  domId: "aiera-event" // optional: id of dom element to which the iframe will be added, defaults to “aiera-event"
});

Parameters

Parameter	Description	Required	Default Value
apiKey	Your org's API key		N/A
eventId	The Aiera event id		N/A
userId	An id to uniquely identify users in your system. this is opaue on our end, but is required to properly save preferences for the user		N/A
domId	The id of the DOM element in which the event iframe will be loaded.		"aiera-event"
environment	The Aiera environment to use.		Default value: Aiera.Environments.production For beta mode use: Aiera.Environments.beta
styles	An object containing links and css string to customize styles for parts of the iframe UI. Currently only supports and events key.		@font-face { font-family: 'Lato'; font-style: normal; font-weight: 500; font-display: swap; src: local('Lato Bold'), local('Lato-Bold'), url(https://fonts.gstatic.com/s/lato/v16/S6u9w4BMUTPHh6UVSwiPGQ3q5d0.woff2) format('woff2'); unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; } @font-face { font-family: 'Lato'; font-style: normal; font-weight: 600; font-display: swap; src: local('Lato Bold'), local('Lato-Bold'), url(https://fonts.gstatic.com/s/lato/v16/S6u9w4BMUTPHh6UVSwiPGQ3q5d0.woff2) format('woff2'); unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; } body { font-family: 'Lato', sans-serif; }

Preferences

Preference	Default	Description
eventMarkupMenu	false	Determines whether or not to show the markup menu

Examples

Beta: Enabling beta mode

Copy

var aiera = Aiera.loadEventFrame({
  environment: Aiera.Environments.beta,
  apiKey: "123456abcdef",
  eventId: 1234567, // the Aiera event id
  userId: 1234567, // id to uniquely identify a user in YOUR system
  domId: "aiera-event" // optional: id of dom element to which the iframe will be added, defaults to “aiera-event"
});

Preferences: Show markup menu

Copy

var aiera = Aiera.loadEventFrame({
  apiKey: "123456abcdef",
  eventId: 1234567, // the Aiera event id
  userId: 1234567, // id to uniquely identify a user in YOUR system
  domId: "aiera-event" // optional: id of dom element to which the iframe will be added, defaults to “aiera-event"
});
// Turn on the markup menu
aiera.addPreference('eventMarkupMenu', true);

Styles: Override to use Google Lato font

Copy

styles: {
    event: {
        links: ['https://fonts.googleapis.com/css?family=Lato:100,300,400,700,900&display=swap'],
        styles: [
            " \
           @font-face { \
             font-family: 'Lato'; \
             font-style: normal; \
             font-weight: 500; \
             font-display: swap; \
             src: local('Lato Bold'), local('Lato-Bold'), url(https://fonts.gstatic.com/s/lato/v16/S6u9w4BMUTPHh6UVSwiPGQ3q5d0.woff2) format('woff2'); \
             unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; \
           } \
           @font-face { \
             font-family: 'Lato'; \
             font-style: normal; \
             font-weight: 600; \
             font-display: swap; \
             src: local('Lato Bold'), local('Lato-Bold'), url(https://fonts.gstatic.com/s/lato/v16/S6u9w4BMUTPHh6UVSwiPGQ3q5d0.woff2) format('woff2'); \
             unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; \
           } \
            \
            body { font-family: 'Lato', sans-serif; } \
        "
        ]
    }
}

Events

aiera.on(eventName, listener);