Skip to main content

Peach API Security Slack Notifications

Project description

This tool provides notification ability via Slack, the popular messaging application.


Installation of this tool has two steps.

  1. Create the app and webhook in Slack. See documentation for steps.

  2. Install peach2slack

pip install peachapisec-slack

  1. Start using the tool



–api –api_token=xxxx –slack_webhook

All parameters can also be provided via environment variables. This is especially usefull for the Slack webhook url, which can then be stored in your CI secrets store.



Peach API Security API URL. Defaults to PEACH_API environ.


Peach API Security API Token. Defaults to PEACH_API_TOKEN environ.


Slack webhook URL. Defaults to PEACH_SLACK_WEBHOOK environ.


[optional] Message template to post when no issues are found. Defaults to PEACH_MSG environ.

Defaults to: Security testing completed succesfully, no issues found after {{tests_count}} tests.


[optional] Message template to post when issues are found. Defaults to PEACH_FAILMSG environ.

Defaults to: A total of {{failure_count}} failures from {{tests_count}} tests were found.


[optional] Error message template to post when job did’t complete. Defaults to PEACH_ERRORMSG environ.

Defaults to: Error: {{reason}}

Message Template

A message template is provided using any of the following placeholders:


Count of failured identified during job


Job Identifier (GUID)


Url to job details. Requires ‘baseurl’ be provided.


Tags set on job


Project name


Job completion reason. Succes or error message.


Count of security tests performed during testing

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peachapisec-slack-1.5.41.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

peachapisec_slack-1.5.41-py2-none-any.whl (4.5 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page