Skip to content

Triggers ​

  • N/A

Consumer notes ​

Use eventId as the idempotency key.

MANUAL_SCREENING.CREATED.schema.json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "EntityProperties": {
      "type": "object",
      "properties": {
        "accessOrder": {
          "type": "boolean"
        },
        "loadFactor": {
          "type": "number"
        },
        "threshold": {
          "type": "integer"
        }
      }
    },
    "EntityProperties-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/EntityProperties"
        }
      ]
    },
    "ManualScreeningDisposition": {
      "type": "string",
      "enum": [
        "APPROVE",
        "REJECT",
        "DISMISS"
      ]
    },
    "ManualScreeningDisposition-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/ManualScreeningDisposition"
        }
      ]
    },
    "ManualScreeningMatchStatus": {
      "type": "string",
      "enum": [
        "PENDING",
        "MATCH",
        "NO_MATCH",
        "SKIPPED"
      ]
    },
    "ManualScreeningMatchStatus-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/ManualScreeningMatchStatus"
        }
      ]
    },
    "ManualScreeningStatus": {
      "type": "string",
      "enum": [
        "NEW",
        "OPEN",
        "IN_REVIEW",
        "CLOSED",
        "RE_OPEN"
      ]
    },
    "ManualScreeningStatus-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/ManualScreeningStatus"
        }
      ]
    },
    "Map(String,Double)": {
      "type": "object"
    },
    "Map(String,Double)-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/Map(String,Double)"
        }
      ]
    },
    "ScoredEntityResponse": {
      "type": "object",
      "properties": {
        "caption": {
          "type": [
            "string",
            "null"
          ]
        },
        "datasets": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "features": {
          "$ref": "#/$defs/Map(String,Double)-nullable"
        },
        "firstSeen": {
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastChange": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastSeen": {
          "type": [
            "string",
            "null"
          ]
        },
        "match": {
          "type": "boolean"
        },
        "properties": {
          "$ref": "#/$defs/EntityProperties-nullable"
        },
        "referents": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "schema": {
          "type": [
            "string",
            "null"
          ]
        },
        "score": {
          "type": "number"
        },
        "target": {
          "type": "boolean"
        }
      }
    },
    "ScoredEntityResponse-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/ScoredEntityResponse"
        }
      ]
    },
    "WebHookManualScreeningMatchData": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "manualScreeningId": {
          "type": [
            "integer",
            "null"
          ]
        },
        "payload": {
          "$ref": "#/$defs/ScoredEntityResponse-nullable"
        },
        "reviewedBy": {
          "$ref": "#/$defs/WebhookUserData-nullable"
        },
        "status": {
          "$ref": "#/$defs/ManualScreeningMatchStatus-nullable"
        }
      }
    },
    "WebhookUserData": {
      "type": "object",
      "properties": {
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "username": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "WebhookUserData-nullable": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/WebhookUserData"
        }
      ]
    }
  },
  "type": "object",
  "properties": {
    "assignedUser": {
      "$ref": "#/$defs/WebhookUserData-nullable"
    },
    "createdAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "createdBy": {
      "$ref": "#/$defs/WebhookUserData-nullable"
    },
    "disposition": {
      "$ref": "#/$defs/ManualScreeningDisposition-nullable"
    },
    "dispositionAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "matches": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/WebHookManualScreeningMatchData"
      }
    },
    "matchesCount": {
      "type": [
        "integer",
        "null"
      ]
    },
    "status": {
      "$ref": "#/$defs/ManualScreeningStatus-nullable"
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "updatedBy": {
      "$ref": "#/$defs/WebhookUserData-nullable"
    }
  }
}