Custom Export Button Integration
The custom export button in magicplan serves as both an export tool and a notification mechanism. When users press the button, it notifies your system that they have completed their work on a project. This allows your system to process the project further based on your requirements.
magicplan generates files specified in the formats
field of the workspace configuration. However, if the generated files do not meet your needs, you can use other APIs to fetch additional files or data required for your workflow. This flexibility ensures your integration remains robust and adaptable to different use cases.
The export button can be configured either through the magicplan Cloud settings or by using the Workspace Update API. This integration is designed to be user-friendly and can be set up without additional support.
Configure the Custom Export Button in the Settings PageCopied!
Follow these steps to configure the custom export button:
-
Log in to magicplan Cloud as a Workspace admin.
-
Navigate to the Settings section of your Workspace.
-
Enter a public URL for your logo (1) to customize the appearance of the export button.
-
Provide a description for the export button (2) as it will appear in magicplan.
-
Specify the email address (3) to receive exported projects.
-
-
Save your configuration to activate the custom export button.
Additional Option:
-
Apply export configuration for all members: Use this setting to overwrite the export settings of all Workspace and Team members with the updated configuration.

Configure the Custom Export Button Using the Workspace Update APICopied!
To enable the custom export button via the Workspace Update API, update the following fields in your workspace configuration:
-
Fields required for proper display:
-
webhook_url
,name
,description
,logo
.
These fields ensure the button is displayed correctly in the magicplan app. For example, a button without a logo may appear incomplete or unprofessional.
-
-
Optional fields:
-
formats, listing_url
,authorize_url
, andnotify_user
.
These fields enable additional functionality, such as project listing, transfer authorization, or user notifications upon export.
-
Although none of the fields are strictly mandatory, including them enhances the appearance and functionality of the export button.
To apply these settings, send a PUT
request to the Workspace Update API endpoint with the updated values.
For ideas on how to integrate the custom export button into your system, see Workflow Examples section.