Integration Description File
General#
The integration description file is designed to provide the supported use cases of the integration, as well as to help XSOAR users to easily configure an instance of the chosen integration.
- Give as much information as you think the user of this integration needs to succeed. Permission levels, credentials, keys, etc.
- If there are permissions required on the integration level, list them in the description.
- If commands have separate permissions, mention that fact in the description, but document the required permission on the command level.
Common cases are:
- How to get credentials
- How to get API Key/Secret
- How to get Applications ID
Path#
The description file should be placed along with all of the integration's files.
For example, if the Pack name is HelloWorld and the integration name is also HelloWorld, the description file path is:
Data#
The description file should contain details on how to configure an instance of the integration, together with the relevant details needed from the product that are important to perform an easy configuration. The file's content can include troubleshooting tips and advanced details for different configuration cases.
note
This should not be confused with the integration README file, documented here.
Images#
Images can be added to your documentation files. For information, see Images in Documentation Files.
Example#
This is the contents of the HelloWorld_description.md file:
Cortex XSOAR versions up to 6.0#
The content of the description file will be displayed:
Cortex XSOAR versions 6.1 and above#
Starting from version 6.1, the content of the description file is shown on the side of the configuration data:
Support Level Header YML metadata key#
The supportlevelheader key can be set to one of the following values to set the support level header in the content description.
xsoar- The description would specify that PANW supports this integration.partner- The description would specify that this integration is partner supported and list the partner's contact information.community- The description would specify that this integration is community supported or list the pack's author.
How To Set the Support Level Header YML metadata key#
Open the yml of the integration in the same folder where the description file is located and add the supportlevelheader key with one of the xsoar/partner/community values.
If this key is not set in the integration's yml, the support level header is set to the support key in the pack_metadata.json.