The email parser API enables you to create and manage inbound email integrations, setting specific parsing rules to extract alert data from the subject and body of an email.
Ideal for monitoring tools and systems that do not support REST API, the created parser object extracts alert data such as status, description, and additional properties right from the email's subject or body. The parser supports both text and HTML content.
Each alert should be sent in a separate email.
The parser is not able to parse attachments - all alert data must be in the subject or body of the email.
A unique email parser must be configured for each source that will be sending emails to BigPanda
This feature is currently only available through the Beta program and must be toggled on in your system before it can be used. To request access to the Beta program, contact [email protected]
See the Integrations Overview guide for a full explanation of the permissions required to access the Integrations section and the Email Parser API.
To learn more about how BigPanda's permissions work, see the Roles Management guide.
Before an email integration can be configured using the Email Parser API, the integration must be created within the UI.
Follow the in-product steps to create a new Alerts API Integration and make note of the app key and integration id.
Once created, the integration can be configured through the email parser API
A User API Key is required for authentication.
There are 2 pre-defined extraction rules. These rules can be customized, but cannot be deleted. Additional rules to extract additional properties can be configured
Each rule can be configured to pull from the subject or body of the email.
This lookup rule searches in the subject or body for specific strings. If there is a match, the defined status will be populated. If not, the next rule will be run. If none of the rules match, the default value will be populated.
Default Mapping Rules:
“Has been resolved”
- If none of these are matched, the default status is ‘critical’
- Populated automatically from the “FROM” address and cannot be changed
Additional alert properties can be extracted from the email payload.
The following must be defined for each property:
- Tag name
- Source - select either Subject or Body
- Extraction rule - the regex rule to extract the value from the email. The extraction rule cannot be empty.
The Email Parser API provides the following objects:
|Object||Description||Supported Methods||API Endpoint|
|Parser Configuration Object||The extraction rules to retrieve alert data from raw email text||POST||https://integrations.bigpanda.io/configurations/alerts/emailparser/|
|Create Configuration||POST /configurations/alerts/emailparser/||Create extraction rules for the email parser|
|Update Configuration||POST /configurations/alerts/emailparser/||Update extraction rules for the email parser|
|Retrieve Configuration||GET /configurations/alerts/emailparser/||View existing email address and extraction rules for a configured email parser integration|