Skip to main content
GET
/
v2
/
webhooks
/
screening
List screening webhooks
curl --request GET \
  --url https://admin-api.gominerva.com/v2/webhooks/screening \
  --header 'x-api-key: <api-key>'
{
  "records": [
    {
      "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"
    }
  ],
  "totalRecords": 1,
  "totalPages": 1
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
page
integer
default:1

The current page cursor to fetch, starting at 1

Required range: x >= 1
​
perPage
integer
default:25

The number of records to fetch per page

Required range: 1 <= x <= 100

Response

Successful response with paginated webhooks

Paginated list of webhooks

​
records
object[]
required

Array of webhook records

​
totalRecords
integer
required

Total number of records

Example:

5

​
totalPages
integer
required

Total number of pages

Example:

1