Skip to main content

 Services

Web services from /about to /webhooks

report group error

/groups/{group}/error/report [POST]

Description

Reports an error to the appropriate person when they occur within the context of a group.

This service allows 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.

To report errors which occur outside a group use the Service: /error/report [POST] instead.

Configuration

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

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