Create a new webhook listener

post

https://api-screening.digai.ai/api/v1/public/notification/webhooks

This endpoint creates a new webhook listener with the provided details and returns the created webhook information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload to create a new webhook listener

name

string

required

Name of the webhook listener

description

string

required

Description of the webhook listener

url

uri

required

URL to send the webhook notification

method

string

required

HTTP method to send the webhook notification. ONLY POST is supported at the moment

eventType

array of strings

required

length ≥ 1

Type of events that triggers the webhook listener.
NEW_APPLICATION: triggered when a candidate finishes an application.
APPROVAL: triggered when a candidate is approved.
INCLUSION_REQUEST: triggered when a candidate declares a speech/communication difficulty (inclusion request).

eventType*

Allowed:

token

string

Bearer/Basic token to authenticate the webhook listener. If not provided, the webhook listener will make an unauthenticated request

If the provided authType is BASIC, the token should be a base64 encoded string of the format 'username:password'

authType

string

enum

required

Type of authentication for the webhook listener
NONE: No authentication required
BASIC: Basic authentication
BEARER: Bearer token authentication

Allowed:

Responses

400

Bad Request: Invalid or missing parameters.

401

Unauthorized: The token is invalid or expired.

403

Forbidden: The user does not have permission to create this resource.

429

Too Many Requests: Rate limit exceeded.

201The webhook listener has been successfully created.