Skip to main content
PATCH
Update screening webhook

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

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