Introduction
| Status | |
|---|---|
|
...
|
...
|
| Note |
|---|
Security DisclaimerPlease note that this feature sends potentially sensitive data in a JSON payload across to a user configured endpoint! Please review if the data sent via this feature is appropriate for the URI endpoints configured. Only send data to websites/endpoints that you trust or authorise. Consider your Data Protection Regulations. |
...
Interface definition
Please visit out our API javadoc page: http://ppl-docs.s3-website-us-east-1.amazonaws.com/JEMH/3.3.50/com/javahollic/jira/emh/api/export/beans/IJEMHInboundMailProcessingWebhook.htmlSetuphtml for the interface definition.
JSON example
| Info |
|---|
Processing outcomes such as Forward, Dropped, Successful etc… do not prevent the webhook call as the webhook is independent from the event listener. |
Successful Outcome
| Code Block | ||
|---|---|---|
| ||
{
"auditEntryLink": "http://localhost:8080/secure/admin/jemh/JEMHAuditing.jspa?reportId=111",
"emailSenderAddress": "customer@localhost",
"processedOutcome": "canHandle",
"catchEmailAddress": "changeme@thiswontwork.com",
"auditEventId": 111,
"processedSuccessfully": true,
"profileId": 1,
"createdIssueKeys":
[
"JSMIT-42"
],
"emailSubject": "test This is a starting email template, update as required",
"timestamp": "2021-08-24 16:44:54.397"
} |
Unsuccessful Outcome
| Code Block | ||
|---|---|---|
| ||
{
"auditEntryLink": "http://localhost:2990/jira/secure/admin/jemh/JEMHAuditing.jspa?reportId=20",
"auditEventId": 20,
"catchEmailAddress": "changeme@thiswontwork.com",
"emailSenderAddress": "mailer-daemon@googlemail.com",
"emailSubject": "This is a starting email template, update as required",
"filterAction": "drop",
"filterName": "Whitelisting/Blacklisting filter",
"filterReason": "Silently dropping (no forward) blacklisted email [type=Profile Blacklist/Whitelist, detail=Email Sender 'mailer-daemon@googlemail.com' was blacklisted due to clause: mailer-daemon@googlemail.com] : from [mailer-daemon@googlemail.com], subject: This is a starting email template, update as required, sent: Sun Jun 19 06:42:26 BST 2011 BlacklistHandling is DROP, returning 'drop' to delete the mail from the queue.",
"processedOutcome": "drop",
"processedSuccessfully": true,
"profileId": 20,
"timestamp": "2021-08-24 16:51:57.168"
} |
Requirements
Webhook Endpoint Requirements
...
Hover over the invalid webhook lozenges to see further information on the cause of invalid webhook.
...
You will one One of the following titles with the error reason will pop up:
URI Not allowed: Verify that the URI is valid for your Jiras Allowlist via Administration > Security > Allowlist see: https://thepluginpeople.atlassian.net/wiki/spaces/JEMH/pages/3296264195/Use+Webhooks#Jira-Allow-List .
URI Invalid Syntax: Verify that the URIs provided follow the URI Syntax see: https://enthepluginpeople.wikipediaatlassian.orgnet/wiki/Uniform_Resource_Identifier#Syntaxspaces/JEMH/pages/3296264195/Use+Webhooks#URI-Syntax
Tracking Webhook outcomes via Auditing report
...
[FAILED] Report Outcome for Webhook
If there are failures shown in your Webhooks section If the webhook outcome is [FAILED] in the affected Incoming Mail Audit Report review the failure message as shown below:
...
Failed due to Allowlist validation
Failed due to failed URI syntax validation
Failed due to general IO Exceptions. Commonly due to endpoint failing to response within 10 seconds as per https://thepluginpeople.atlassian.net/wiki/spaces/JEMH/pages/3296264195/Use+Webhooks#Webhook-Endpoint-Requirements or endpoint connection closed early.neccessary