Copyright (c) 2018 ThreatConnect, Inc.

ThreatConnect Playbooks

This repository gives ThreatConnect customers the ability to create and share Playbooks and Playbook Apps for use with their instance of ThreatConnect. Our hope for this repo is that it will:

• Help promote usage of ThreatConnect via a community of developers,
• Help customers identify new use cases, and
• Give new customers the opportunity to learn from existing customers.

This Repository is public. However, contributions will be accepted only from identified ThreatConnect customers. The ThreatConnect Support Team will validate each contribution request before they are published within the Repository, as well as enforce certain formatting requirements.

Please Note: the Support Team will not validate code for functionality or security.

Guidelines

• All Playbooks and Playbook Apps must have their own README.md files.
• Playbooks README.md should include the following headers:
  • Summary
  • App Dependencies
  • Use Cases (Optional)
• Playbooks Apps README.md should include the following headers:
  • Summary
  • Dependencies
  • Input Definitions
  • Output Definitions
  • Use Cases (Optional)
• Playbooks and Playbook Apps should be included in unique, separate folders.
• Playbooks must include the PBX file of the Playbook.
• Playbook Apps must include the zip/tcx file of the App.

Contributing

For more information on contributing to this repository, see our Contributions Guide.

Documentation

Documentation for the ThreatConnectⓇ App Framework is available here: https://docs.threatconnect.com/en/latest/tcex/tcex.html. The framework provides commonly used Classes and Methods for writing ThreatConnect Apps. The Framework is intended to speed up the development process and ensure Apps contains the core functionality required.

Documentation specific to Playbooks can be found here: https://docs.threatconnect.com/en/latest/tcex/playbook.html.

Best practices for creating effective and maintainable Playbooks can be found here: https://github.com/fhightower/playbook-paradigms-and-constructs.

Contact

If you have any questions, bugs, or requests please contact support@threatconnect.com.

License

Access to this Repository is governed by the Apache 2.0 License.

Terms of Service

Access to this Repository is governed by the following Terms of Service.