Plan Events API
Retrieve planning events, such as member promotions and plan changes.
Access requirements
To use APIs, you must have a Visier account and authenticate. For more information about authenticating, see API Authentication.
You must be the plan owner or have co-owner access to the plan. For more information, see How to Share Your Plan.
Reach out to your administrator for access.
Note: To access a sample script that polls a plan for recent promotion events and loads data into the promoted rows, see Planning Events on GitHub.
Overview
The Plan Events API allows you to retrieve a record of the events that occur in your plans, such as member promotions, plan and scenario changes, data loads, and sharing changes. You can use planning events to build an audit trail of plan activity or monitor changes made by other users.
An event occurs when a tracked action happens in a plan. Some common events include:
- A subplanner's custom member is promoted into the main plan.
- Multiple rows are promoted or demoted at once.
- Changes to a plan's lifecycle such as creation, deletion, and plan renames.
- Data is loaded into a plan.
- Collaboration and subplan activity such as subplan creation and submission.
- Changes to who a plan is shared with.
- Comments are added to a plan.
For the full list of event types, see "Plan Events" in API Reference.
Tip: To be notified as soon as a row is promoted into a plan, rather than polling for events, create a webhook for the planRowPromotionNotification event. The webhook payload includes the eventID, which you can use to retrieve the event's full details. For more information, see Webhooks API.