Monterosa Automation

Interact with Monterosa Control API

Actions11

Overview

The "Update Event" operation in the Monterosa Automation node allows users to modify existing events within a specified Monterosa project. This includes updating event attributes such as name, start time, duration, and custom fields, or performing actions like starting or stopping an event.

This node is beneficial for automating event management workflows where event details need to be programmatically adjusted or controlled based on external triggers or schedules. For example, you could update the start time of a marketing campaign event or programmatically stop an event once certain conditions are met.

Properties

Name Meaning
Project ID The unique identifier of your Monterosa project. Required to specify which project the event belongs to.
Localization Specifies the localization context for custom fields. Default is "all".
Event ID The identifier of the event to be updated.
Event Start Time The new start time of the event (date and time).
Update Type What aspect of the event to update:
- Attributes: Update event details like name, timing, and custom fields.
- Action: Perform an action on the event such as start or stop.
Action When Update Type is "Action", choose:
- Start: Start the event.
- Stop: Stop the event.
Event Name New name for the event when updating attributes.
Event Start Mode How the event start time is determined:
- Manual: User specifies start time manually.
- Clock: Event starts at a scheduled clock time.
Event Start At Planned start timestamp for the event (used when Event Start Mode is "clock").
Event End Time Scheduled end time for the event (used when Event Start Mode is "clock" and End Mode is "scheduled").
Duration Duration of the event in minutes (used when Event Start Mode is "manual").
End Mode How the event should end (used when Event Start Mode is "clock"):
- Duration: Ends after a set duration.
- Scheduled: Ends at a specific scheduled time.
Repeat Whether the event should repeat (true/false).
Repeat Interval (Minutes) Interval in minutes between repeated events, i.e., how long after the previous event ends the next one starts (only if Repeat is true).
Custom Fields Custom key-value pairs to add or update on the event. Allows adding multiple custom fields with arbitrary keys and values.

Output

The node outputs JSON data representing the updated event object returned from the Monterosa Control API. This typically includes the event's current state after the update, such as its ID, name, start and end times, status, and any custom fields.

If the operation involves starting or stopping the event (action update type), the output reflects the event's new status accordingly.

No binary data output is involved in this operation.

Dependencies

  • Requires a valid API authentication token credential for the Monterosa Control API.
  • Requires the Project ID to identify the target project.
  • Network access to Monterosa Control API endpoints.
  • Proper permissions on the API token to update events.

Troubleshooting

  • Invalid Project ID or Event ID: Ensure that the provided Project ID and Event ID exist and are correct. Errors may indicate "not found" or "unauthorized".
  • Authentication errors: Verify that the API token credential is valid and has not expired.
  • Invalid date/time formats: Make sure date-time inputs conform to expected ISO 8601 format.
  • Conflicting parameters: For example, specifying both manual start mode and clock start mode parameters simultaneously can cause errors.
  • API rate limits or network issues: Temporary failures might occur due to connectivity or API throttling; retry after some time.
  • Custom fields format: Ensure custom fields are provided as key-value pairs; missing keys or values may cause rejection.

Links and References

Discussion