Set Webhook

POST

/webhook/register

This API is used to register or update a webhook URL that will receive event notifications from the system. Optionally, you can also provide an accessKey and secretKey for securing webhook requests.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/webhook/register' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "webhook_url": "https://webhook.site/testing-webhook",
    "webhook_access_key": null,
    "webhook_secret_key": null
}'

Response Example

{}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Modified at 2025-08-22 08:27:31

Example Webhook payload

Get Webhook