Skip to main content
PATCH
/
v2
/
webhooks
/
screening
/
{webhookId}
Update screening webhook
curl --request PATCH \
  --url https://admin-api.minervaai.io/v2/webhooks/screening/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "webhookName": "Updated webhook name",
  "events": [
    {
      "kind": "profile_status_updated",
      "values": [
        "accepted",
        "rejected"
      ]
    }
  ],
  "url": "https://updated.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"
        ]
      }
    ],
    "url": "https://your.web.site/path"
  }
}

Authorizations

​
x-api-key
string
header
required

Admin API key for authentication

Path Parameters

​
webhookId
string<uuid>
required

The unique identifier of the webhook

Body

application/json

Request body for updating a screening webhook

​
webhookName
string

The name that should be assigned to the webhook

Example:

"Updated webhook name"

​
events
object[]

The list of events that the webhook should subscribe to

​
url
string<uri>

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

Example:

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

Response

Webhook updated 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