Page History

...

The response to a widget instance request contains a URL; typically you would use this information to construct an iframe tag with the correct height and width. Generally this is all that is needed to include a widget served by Wookie.

Adding Participants

Participants are added to a Widget Instance using the Participants REST API. The format of the request can be found in the Wookie REST API documentation, however the main points to bear in mind are how to construct the request parameters. As well as the usual parameters (API key, shared data key, widget id, user id) this method requires:

participant_id: An identifier for the participant in the application. This doesn't need to be a "real" identifier, and can be a hashcode or other opaque value; you just need to be consistent.

participant_display_name: A name to display for the participant; typically a nickname or any other name commonly displayed in the application for this participant.

participant_thumbnail_url: A URL pointing to the participant's icon or avatar, if they have one. This should be an absolute URL.

Initial state information

...