Intended Audience: Technical Alliances, Business Development, and Product Management Teams
Building Cortex XSOAR integrations is easy and we welcome and encourage contributions from our customers and partners. If you are a Technology Partner and want to include your product among the Cortex XSOAR supported integrations, there are a few requirements and steps that must be followed.
Understand all the benefits of becoming a Cortex XSOAR Technology Partner here
As we aim to provide a smooth and seamless partner onboarding experience, we encourage you to review the following requirements and reach out to us for any doubts of clarification requests.
While most of the work is technical, we have a few requirements on the business side:
- Identify and communicate your primary points of contact for business and technical/dev side (Slack is our preferred channel of tech communications)
- Complete the Technical Partner Agreement (more details below)
- Support your integration with customers and enroll in TSA Net (see below)
- Provide our team with access to your product for our content testing purposes
If you are creating integrations for your products on Cortex XSOAR, you will need a Python developer. While a great deal of automation content (Playbooks, Dashboards, Layouts, etc.), can be created for the platform without developers, building your own integration requires such a resource.
At minimum you will need the following capabilities:
- Intermediate knowledge of Python 3.x (including basic concepts of linting and unit testing)
- A strong understanding of your product's capabilities
- A strong understanding of your product's APIs
- Access to your company's product and APIs
- An installed Cortex XSOAR Platform (you can install it on-prem or cloud: we will provide the licenses)
- Access to GitHub
- Optional: basic knowledge of Docker, if you want to use your own libraries or pip modules
Partner Onboarding Process
The following steps explain the process that you need to go through in order to become a Palo Alto Networks Technology Partner with Cortex XSOAR, and start developing content and integrations that can be certified and deployed to customers globally. Please review the following with your team and work with your Cortex XSOAR Technical Alliances contacts to get started.
1. Sign up as a Technology Partner
Submit your application now! After your application is approved you’ll receive an email with a few resources to help you get started, and we'll reach out for a follow up.Sign Up Now
2. Complete the Technical Partnership Agreement
Prior to acceptance into the program, all partners must complete and sign our Technology Partner Program Agreement (TPA). You must identify in the TPA which of your product(s) you wish to have integrated with Cortex XSOAR. Due to the large number of partners, we prefer to use our DocuSign to expedite the process. We'll reach out to arrange for signatures.Download the partnership agreement here
3. Take Required Training
We require our Partners to take two training classes at the Palo Alto Networks Learning Center prior to beginning development. The classes are (1) “Demisto Fundamentals” and (2) “Cortex XSOAR Engineer.” Create a free Guest account with your business email address (instructions) and search for those two titles to enroll instantly. (Note: you must use your business email to ensure accurate reporting and tracking.) Total time: ~3hrs
4. Identify the Use Cases
Once you're accepted in the program, we'll provide you access to a few resources, including our Support Portal. We'll also reach out to schedule a 60 minute technical call to identify the use cases. We expect a representative of your technical team to be in the call. Typically the flow of the call is:
- General overview/demo of Cortex XSOAR, its capabilities and integration requirements
- General overview/demo of your product(s)
- Open discussion on use cases
At the end of the call we will share a document template, already partially compiled, that outlines the scope of the integration. The document includes concepts such as:
- Use cases
- Commands/APIs used
- Input for commands
- Context output for commands
- Raw output for commands
We'll ask you to complete the document and submit back to us for review. We will be available for clarification and follow up conversations.
5. Build the Integration
Once the use cases document is approved, we will provide you with the Cortex XSOAR licenses. We encourage you to identify the technical team and provide us their contacts so we can create accounts on our Support Portal and invite them in our Slack workspace. We will create a private Slack channel and invite your team as well as representatives of our engineering team.
We will also provide you a Partner ID that you will use during the GitHub submission process once the integration is complete.
We recommend your technical team review the docs on this site, and the following useful resources:
- Our GitHub Content repository, and
- Cortex XSOAR Support Portal
- Cortex XSOAR Platform Installation Guide
- Slack #demisto-integrations-help
- Cortex XSOAR Concepts, and Terminology
- Cortex XSOAR Getting started video tutorial
Please reach out on Slack if you need any technical assistance or guidance. Follow the Getting Started Guide to understand all the requirements and components.
At a minimum, an integration consists in:
- The Python code that connects to your product(s)
- Metadata that defines inputs/outputs/descriptions/etc.
- A logo, appropriate, category, and all integration information defined
- Auto generated Integration documentation
- Documentation for customers on how to use the integration
- Python Unit test(s) for automated testing
- Ability to test the integration, build test playbooks, and use the integration from the CLI
- A couple of example playbooks to showcase how your your integration could be used
6. Provide our Team with Product Access
As an automation platform, it shouldn’t surprise you that we’ve also automated our integration testing and deployment. We do nightly tests of each integration in order to confirm functionality and, in order to do this, we require access to your product and/or APIs. Preferably, the instance will have all data related to the integration use cases, so they can be tested. E.g. if one of the use cases is ingesting incidents to Cortex XSOAR, the instance should have demo incidents. This access is not used for any other purpose.
Before submitting the integration, please work with the Palo Alto Networks BD Team to share access
7. Submit a GitHub Pull Request
Once you have completed development of your content or integration, please submit a Pull Request on our GitHub Content Repo. The title of the Pull Request must contain the Partner ID we provided earlier.
After the PR is submitted, it will require a review session with the development team. When the review of your integration is complete, check your code into our GitHub repository. Your build will added to be published to our global community. We release content updates every two weeks.
8. Join TSANet
To have their integrations approved and shipped with the Cortex XSOAR Content, we require our partners to join the industry-standard support framework called TSANet in order to deliver outstanding support to our mutual customers. It’s free when you register under the Palo Alto Networks account, and it really streamlines the cross-company processes. Sign Up For TSANet.
9. Get the word out
Now that the integration is complete, you'll get the visibility you deserve! Our BD team will connect you to our Marketing team to work together on content, such as Solution Briefs, Blog posts, YouTube videos, etc.