Skip to main content
GET
/
v2
/
webhooks
/
screening
/
{webhookId}
Get screening webhook
curl --request GET \
  --url https://admin-api.gominerva.com/v2/webhooks/screening/{webhookId} \
  --header 'x-api-key: <api-key>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Admin API key for authentication. Manage API keys in the Minerva dashboard under Administration > Developers.

Path Parameters

​
webhookId
string<uuid>
required

The unique identifier of the webhook

Response

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