Example 5: Export and Visualize

This workflow uses exported files to generate dashboards and actionable insights.

Steps:

  1. Create Project:
    Use the external_reference_id parameter in the Create Project API to link the magicplan project to your local system.

  2. 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.

  3. Webhook Notification:
    magicplan sends a POST request to your webhook_url, including:

    • The listing parameter, which identifies the local project linked to the magicplan project.

    • File URLs (valid for 60 minutes).

    • Additional project metadata.

  4. Data Extraction:
    Extract key details (e.g., room dimensions, materials, costs) from the downloaded files.

  5. Dashboard Creation:
    Visualize the extracted data in dashboards, highlighting:

    • Resource usage.

    • Completion rates.

    • Project progress.

  6. Webhook Response:

    • Status 0: Success, with a confirmation displayed to the user.

    • Other statuses: The user is shown an error and can retry the export.


Use Case Example

A business analytics team tracks project performance and visualizes insights for management.