When a Pending Match Request is resolved, Match can be configured to send a JSON message to a URL endpoint. This allows automatic business processes to be triggered once a Reconciliation Manager reviews and resolves a Pending Match.
(This Notification protocol is not part of the TAP Match API.)
Currently only one Endpoint is supported per Matchgrid.
The JSON message format is described in this JSON Schema document.
sor
: The System of Record label, as configuredsorid
: The System of Record Identifier, as provided in the initial match requestrequestId
: The identifier assigned by Match to the initial match request{ "meta": { "source": "COmanage Match", "event": "match-resolution", "format": "1" }, "sor": "hrms", "sorid": "A595847", "matchRequest": "136", "referenceId": "ac22eb2b-37a8-4faa-b427-8b5a399d9fcf", "resolutionTime": "2022-08-07T15:00:03Z" } |
The JSON document will be transferred to the exact URL as configured using HTTP POST. The content-type will be set to application/json
.
Any HTTP Response Code in the 2xx range (>= 200, <= 299) is treated as successfully sent.
Any other HTTP Response Code is treated as an error. On error, the endpoint may return a simple JSON document with an error that will be recorded in the Matchgrid History for the subject SOR/SORID.
{ "error": "Something went wrong" } |
There is not currently a mechanism for retrying notifications that were not accepted by the endpoint.
COmanage Registry can be configured to process Endpoint Notifications, as described here.