Contributing an extension
Interested in sharing an extension you’ve built with the wider Rapid7 community? You’re in luck because the Extension Library is now accepting external contributions! Just click the orange Contribute button in the header of the The Extension Library. Alternatively you can visit extensions.rapid7.com/contribute. Sign in with your regular Insight platform login (the one you use to login to insight.rapid7.com), fill out the contribution form, and our team will be notified of your submission.
Questions about contributing?
If you have any questions about contributing, or just aren't sure if your workflow, integration, or extension is acceptable, then please get in touch with us! We would be glad to answer your questions or set up some time to review your extension with you. Just shoot us an email at contribute@rapid7.com and we'll be in touch!
Once you have submitted your extension, Rapid7 will review your contribution by importing and testing your extension. If necessary, we will provide feedback or recommended improvements. We may also enhance the provided extension documentation for clarity before publishing your submission to The Extension Library. Our review process typically takes around 4 weeks to complete.
The form itself is broken down into three sections:
Publisher details
This part of the form should be completed with details about your organization. This information will be used to identify who created the extension. The name of your organization and your organization’s logo will be visible on the Extension Library. You can also add support details so users of your extension can get some help if they need it.
Your organization is only required to fill out publisher details for the first contribution. On subsequent visits, the form will be pre-populated with this information.
Extension type
InsightConnect workflow
Workflows can be added directly to InsightConnect. They are a series of actions that execute when a specific event is triggered. Workflows help to streamline and automate your security processes. When contributing a workflow you must have a .icon file to upload.
See InsightConnect’s Help Documentation to learn how to export your .icon file.
Package (integration)
A downloadable stand-alone application or executable file that integrates with one or more Rapid7 products. Package extensions can be filtered by using the Integration product filter on The Extension Library.
Documentation (integration)
An extension that integrates with one or more Rapid7 products and is configured in-product. Documentation extensions listed in the Extension Library are for instructional use only. Documentation extensions can be filtered by using the Integration product filter on The Extension Library.
Extension details
Extension Details is the main part of the contribution form. This is where you fill out the main information about your extension. On the right hand side of the page you’ll see a preview window. This will help you to visualize what your extension will look like when it has been published. If you would like to see what a finished extension looks like you can view our sample extension. This should give you an idea of how the content should be presented. There are also some help menus throughout the form to guild you.
General details
General Details allow you to name and describe your extension. Depending on what type of extension you are creating, you may also have something to upload (in the case of a workflow this could be an .icon file) or you may need to supply a web address (in the case of a documentation extension).
The Overview field should include a short description of what your extension does. This is used on the homepage on The Extension Library.
The Description field is a more detailed explanation of your extension. This is used on the details page on The Extension Library.
Features
The fields in Features give you the opportunity to describe how your extension interacts with Rapid7 applications.
Key Features are used to describe valuable or unique characteristics of your extension. These will be presented as a bulleted list on The Extension Library and should be used to summarize what your extension does.
Requirements are used to inform what products, versions and configurations are needed to run your extension. Each Requirement should state the name of the required dependency. They can include a version number, configuration requirements or anything else required to run the extension.They will be presented in a bulleted list on the extension details page.
Resources
Resources and Links are used to link off to external extension resources, such as white papers, tech sheets, or web pages. For each resources you should supply a Name and a Website/URL. You can link to a maximum of 6 resources. Your resources will be presented in a bulleted list on the extension details page.
Images can be used to visualize your extension. A popular way of using images is to show screenshots of your extension. Images are presented in a gallery on the extension details page. There are a few requirements & suggestions for images:
- Must be JPEG, PNG, GIF or SVG format
- Must be smaller than 2Mb
- For best results image dimensions should not exceed 670px width and 380px height.
A Video can be added to your extension. Videos are presented in the image gallery on the extension details page. You should supply a Title and a URL for your video. We accept embed videos from the following services:
- Youtube
- Vimeo
- Vidyard
Documentation can be added to your extension in two ways:
- Documentation can be uploaded to the form in Markdown format. A template of our documentation format can be downloaded here.
- A link to an external website can be added. Once you have added documentation to your extension it can be found on the right hand side of the extension details page.
Terms of service
All extension library contributions are subject to our terms of service.