Update a webhook listener by webhook ID

patch

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

This endpoint updates the details of a specific webhook listener based on its ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhookId

string

required

Unique identifier of the webhook (UUID v4)

Body Params

Payload to update the webhook listener details

name

uuid

Name of the webhook listener

description

string

Description of the webhook listener

url

uri

URL to send the webhook notification

method

string

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

eventType

array of strings

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 token to authenticate the webhook listener. If not provided, the webhook listener will make an unauthenticated request

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 update this resource.

404

Not Found: The specified webhook does not exist.

429

Too Many Requests: Rate limit exceeded.

200The webhook listener has been successfully updated.