API Reference

Update a webhook listener by webhook ID

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the webhook (UUID v4)

Body Params

Payload to update the webhook listener details

string
required

Name of the webhook listener

string
required

Description of the webhook listener

string
required

URL to send the webhook notification

string
required

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

eventType
array of strings
required

Type of events that triggers the webhook listener.
NEW_APPLICATION: New application event will trigger the webhook listener. Only this event is supported at the moment

eventType*
string
required

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.

Updated over 1 year ago

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago