Example 3: Multi-Step Workflow with Notifications
This workflow enhances collaboration by combining file export with notifications to stakeholders.
Steps:
-
Create Project:
Use theexternal_reference_id
parameter in the Create Project API to link the magicplan project to your local system. -
Export Trigger:
-
Once the project appears in the user's app, they can open the magicplan app.
-
Upon completing the project, the user presses the Custom Export button, signaling that the project is ready for export.
-
-
Webhook Notification:
magicplan sends aPOST
request to yourwebhook_url
, including:-
The
listing
parameter, which identifies the local project linked to the magicplan project. -
File URLs (valid for 60 minutes).
-
Additional project metadata.
-
-
File Queuing and Downloading:
Your system queues the file URLs and downloads them as soon as possible. -
Notifications:
Notify stakeholders (e.g., project managers, clients) via email, Slack, or push notifications. -
Webhook Response:
-
Status
0
: Indicates success and displays a confirmation message in the app. -
Other statuses: The user sees an error and can retry.
-
Use Case Example
A project manager is notified automatically when floor plans are exported, streamlining review processes.