Skip to main content
POST
/
v2
/
webhooks
/
screening
Create screening webhook
curl --request POST \
  --url https://admin-api.minervaai.io/v2/webhooks/screening \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhookName": "Test webhook",
  "events": [
    {
      "kind": "profile_status_updated",
      "values": [
        "potential_match",
        "accepted",
        "rejected"
      ]
    }
  ],
  "url": "https://your.web.site/path"
}
'
{
  "status": 200,
  "message": "Webhook created successfully",
  "result": {
    "id": "ecc9b161-e6bf-48e4-816d-b13046a42eaa",
    "webhookName": "Test webhook",
    "webhookKey": "e7b3b2f0-8e17-40a5-a083-2234c6bc9dab",
    "events": [
      {
        "kind": "profile_status_updated",
        "values": [
          "potential_match",
          "accepted",
          "rejected"
        ]
      }
    ],
    "url": "https://your.web.site/path"
  }
}

Authorizations

​
x-api-key
string
header
required

Admin API key for authentication

Body

application/json

Request body for creating a new screening webhook

​
webhookName
string
required

The name that should be assigned to the webhook. This is for reference purposes, and will be echoed back in the webhook payload together with the webhook unique ID. It can be helpful to assign a system reference ID or other reference code. It can also be used to identify different webhooks as dev vs prod, or by purpose.

Example:

"Test webhook"

​
events
object[]
required

The list of events that the webhook should subscribe to. If more than one event is provided, it is treated as an OR gate where if any of the conditions in the events of the array are applicable, the webhook will trigger. At least one event must be provided.

​
url
string<uri>
required

The URL that the webhook should POST to when event conditions are met

Example:

"https://your.web.site/path"

Response

Webhook created successfully

Standard webhook response

​
status
integer
required

HTTP status code

Example:

200

​
message
string
required

Response message

Example:

"Webhook created successfully"

​
result
object
required

A webhook configuration for screening events