Example 6: Project Versioning Workflow

This workflow maintains and compares multiple versions of a project, supporting detailed change tracking.

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. Version Comparison:
    Compare the newly downloaded files with previously stored versions to track changes.

  5. Version Management:
    Save the updated files with versioning metadata (e.g., version number, timestamp).

  6. Webhook Response:

    • Status 0: Indicates success to magicplan.

    • Other statuses: Prompts an error in the app, allowing users to retry.


Use Case Example

An architecture firm tracks iterative updates to floor plans and maintains a comprehensive version history.