Receive Matcher Transaction Job Completed Event

POST https://webhook.example.com

Webhook event triggered when a Matcher Transaction job has completed processing

application/json

Body Required

  • EventId string(uuid) Required

    Unique Event Identifier

  • CorrelationId string(uuid)

    Correlation identifier

  • EventType string Required

    Event type

  • EventMessage string Required

    Human-readable event description

  • CreatedDate string(date-time) Required

    Time of the event

  • Payload object Required
    Hide Payload attributes Show Payload attributes object
    • Engagement string Required

      Engagement

    • UniqueFileName string Required

      Unique file name

    • Result string Required

      The result of the job processing. Possible values:

      • Succeeded: All records processed successfully
      • PartiallySucceeded: Some records processed with errors
      • Failed: Processing failed
      • Rejected: File was rejected (e.g., malware)
      • WaitingInteraction: Waiting for user input
      • Discarded: Processing was cancelled or discarded
      • Deleted: File was deleted

      Values are Succeeded, PartiallySucceeded, Failed, Rejected, WaitingInteraction, Discarded, or Deleted.

Responses

  • 200

    Webhook received successfully

  • default application/problem+json

    Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
POST MatcherTransactionJobCompletedEvent
Request examples 
{
  "EventId": "string",
  "CorrelationId": "string",
  "EventType": "string",
  "EventMessage": "string",
  "CreatedDate": "2025-05-04T09:42:00Z",
  "Payload": {
    "Engagement": "string",
    "UniqueFileName": "string",
    "Result": "Succeeded"
  }
}
Response examples (default) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}