Skip to main content

 Services

Web services from /about to /webhooks

report error

/error/report [POST]

Description

Report an error to the appropriate person.

This service allows system errors to be sent by email to a configurable address. The address is not necessarily the address of an existing member and can be an address for a support person.

Configuration

For this service to be functional, ensure that the errorReportAddress property is defined in the default Group Properties.

Parameters

NameDescriptionRequiredTypeDefault
contentThe content to be reported, usually a stack trace and/or some system information at time of error yesstring
notify-asyncWhether emails are sent asynchronously (for slow email servers)nobooleanfalse

Permission

The user must be authenticated.

Response

The XML acknowledges that the message was sent:

<error-report report-sent="true" />

Or in JSON:

{
  "reportSent":"true"
}

Error Handling

No specific errors expected for this service.

Created on , last edited on