Skip to main content
POST
Create screening webhook

Authorizations

x-api-key
string
header
required

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

Body

application/json

Request body for creating a new screening webhook

webhookName
string
required

The name to assign to the webhook. This is for reference purposes, and Minerva echoes it back in the webhook payload together with the webhook unique ID. A system reference ID or other reference code works well here. Use it to tell webhooks apart by environment (dev or prod) or by purpose.

Example:

"Test webhook"

events
object[]
required

The list of events the webhook subscribes to. If you provide more than one event, Minerva treats them as an OR gate: the webhook triggers when the conditions of any event in the array apply. Provide at least one event.

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