Monterosa Automation

Interact with Monterosa Control API

Actions11

Overview

The "Create Element" operation in the Monterosa Automation node allows users to create a new element within a specified Monterosa project and event. Elements represent interactive content pieces such as polls, trivia questions, or custom content types that can be associated with live events.

This node is beneficial for automating the creation of interactive elements during event production workflows, enabling dynamic audience engagement without manual intervention. For example, you could automatically create a poll element with predefined options when an event starts, or generate trivia questions based on external data sources.

Users can either build the element using structured form fields (question text, options, voting settings, etc.) or provide a fully custom JSON payload for advanced use cases.

Properties

Name Meaning
Project ID The unique identifier of your Monterosa project where the element will be created.
Localization Defines how text localization is handled: "All Languages" uses the same text for all languages; "English Only" restricts text to English.
Event ID The identifier of the event to which the element will be linked.
Use Custom JSON Boolean flag to indicate whether to use a custom JSON request body instead of the form fields.
Custom JSON A JSON object representing the full request body for creating the element. This allows complete control over the element structure.
Content Type Name or ID Select or specify the content type of the element (e.g., poll, trivia). Options are dynamically loaded based on the project ID.
Start Mode How the element starts: "Manual" means it starts manually; "Timecode" means it starts at a specific offset time from the event start.
Duration (Seconds) Length of time the element remains active, in seconds.
Offset (Seconds) Time offset from the event start when the element should begin (required if Start Mode is "Timecode").
Question Text The main question text for the element.
Question Image URL Optional URL for an image associated with the question.
Question Custom Fields Additional key-value pairs to add custom metadata to the question.
Options Collection of answer options for the question, each with text, optional image URL, and custom fields.
Correct Option 1-based index indicating the correct option (used only for trivia elements).
Voting Settings Settings controlling voting behavior, including certification requirement, inclusion in latest results, max/min options per vote, max votes per user, and whether a verified user is required.

Output

The node outputs a JSON object representing the newly created element as returned by the Monterosa Control API. This includes:

  • data: The main element data object.
    • type: The resource type ("elements").
    • id: The unique identifier of the created element.
    • attributes: Contains element attributes such as content type, start mode, duration, question details, voting settings, etc.
    • relationships: Links to related resources like the event.

If binary data were involved (not applicable here), it would be summarized accordingly, but this node deals primarily with JSON data.

Dependencies

  • Requires a valid API authentication token credential for the Monterosa Control API.
  • Requires the Project ID to load content types dynamically.
  • Network access to Monterosa API endpoints.
  • Proper configuration of environment (e.g., API base URL) via credentials.

Troubleshooting

  • Invalid Project ID or Credentials: If the project ID is incorrect or the API token is invalid, loading content types or creating elements will fail. Verify credentials and project ID.
  • Missing Required Fields: Omitting required properties like Project ID, Event ID, or Content Type will cause errors. Ensure all mandatory inputs are provided.
  • Incorrect JSON Structure: When using custom JSON, malformed or incomplete JSON may result in API errors. Validate JSON structure against Monterosa API documentation.
  • Start Mode and Offset Mismatch: If "Timecode" start mode is selected but no offset is provided, the API may reject the request. Provide a valid offset in seconds.
  • API Rate Limits or Network Issues: Temporary failures might occur due to network problems or rate limiting. Retry after some time or check network connectivity.

Links and References

Discussion