Skip to main content
POST
/
v2
/
webhooks
/
screening
/
{webhookId}
/
test
Test screening webhook
curl --request POST \
  --url https://admin-api.minervaai.io/v2/webhooks/screening/{webhookId}/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventKind": "profile_status_updated",
  "eventValue": "accepted",
  "latestFlags": [
    "Sanctions",
    "PEP",
    "News"
  ],
  "profileId": "minerva-profile-id-1",
  "externalId": "user-profile-id-1"
}
'
{
  "status": 200,
  "message": "Webhook test triggered successfully",
  "payload": {
    "webhookId": "ecc9b161-e6bf-48e4-816d-b13046a42eaa",
    "webhookName": "Test webhook",
    "event": {
      "kind": "profile_status_updated",
      "value": "accepted",
      "meta": {
        "latestFlags": [
          {
            "name": "screeningSanctionsMatch",
            "count": 1,
            "label": "Sanctions"
          },
          {
            "name": "screeningPepMatch",
            "count": 1,
            "label": "PEP"
          },
          {
            "name": "screeningAdverseMediaMatch",
            "count": 1,
            "label": "Adverse Media"
          }
        ],
        "profileId": "minerva-profile-id-1",
        "externalId": "user-profile-id-1"
      }
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Admin API key for authentication

Path Parameters

​
webhookId
string<uuid>
required

The unique identifier of the webhook to test

Body

application/json

Request body for testing a screening webhook

​
eventKind
enum<string>
required

The mock event kind to send in the webhook payload. This will flow through transparently to the mock payload that is sent through to the webhook destination URL.

Available options:
profile_status_updated
Example:

"profile_status_updated"

​
eventValue
enum<string>
required

The mock event value to send in the webhook payload. This will flow through transparently to the mock payload that is sent through to the webhook destination URL.

Available options:
potential_match,
accepted,
rejected
Example:

"potential_match"

​
latestFlags
enum<string>[]

The mock flags that should be sent in the latestFlags webhook payload field. These values are interpreted and mutated into true object mocks in the webhook payload that is sent to the destination URL.

Example:
["Sanctions", "PEP", "News"]
​
profileId
string

The mock profile ID that should be sent in the payload to the destination URL. This is an optional field that can be provided if testing the webhook update for a specific Minerva profile ID within your service logic is desired.

Example:

"minerva-profile-id-1"

​
externalId
string

The mock external ID that should be sent in the payload to the destination URL. This is an optional field that can be provided if testing the webhook update for a specific external system ID within your service logic is desired.

Example:

"user-profile-id-1"

Response

Webhook test triggered successfully

Response from testing a screening webhook

​
status
integer
required

HTTP status code

Example:

200

​
message
string
required

Response message

Example:

"Webhook test triggered successfully"

​
payload
object
required

The payload that was sent to the destination webhook