​
Communication Events: Streamline Your Data Flow with Real-Time Events REST API

Communication events are a versatile REST API designed to simplify communication event management and streamline data flow within your systems. With functionality akin to webhooks but with added flexibility, communication events empower you to effortlessly manage and track events in real-time, ensuring seamless data synchronization across your applications if webhooks do not respond properly.

With communication events, you gain unprecedented control over your communication processes, allowing you to monitor pending or completed events with ease.

​
Integration and details

GET https://[host]:[port]/api/integration-services/v1/communications-events/{communicationNumber}

​
Response

Two options for responses - either events[] or errors[].

​
Event

​
EventData

Check related folder pages for events envelopes and events payload details.
  • Risk management events
  • Screening events

​
Response example

{
  "events": [
    {
      "type": "app.amlyze.customer.riskmanagement.kyc_scoring.completed",
      "source": "2023-06-02T07:24:51.387Z",
      "subject": "extid",
      "data": {
        "initialRiskLevel": "MEDIUM",
        "finalRiskLevel": "MEDIUM",
        "decisionType": "ACCEPTED",
        "approvedAt": "2023-06-11T21:00:00.000Z"
      }
    }
  ]
}

​
Error Message

​
code
string
Error code.
​
description
string
Error description.

​
Response example

{
  "errors": [
    {
        "code": "INTERNAL_SERVER_ERROR",
        "description": "Internal server error"
    },
    {
      "code": "BAD_REQUEST",
      "description": "Communication number is required"
    }
  ]
}