Skip to main content
PUT
/
v1
/
tenants
/
webhook
Configure outbound webhook delivery for a tenant
curl --request PUT \
  --url https://cds.marmar.life/v1/tenants/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Tenant-Code: <api-key>' \
  --data '
{
  "webhookUrl": "<string>",
  "webhookSecret": "<string>"
}
'
{
  "message": "Webhook configured successfully"
}

Authorizations

X-Tenant-Code
string
header
required

Tenant slug returned during registration.

X-API-Key
string
header
required

Tenant API key. The server also accepts the lowercase x-api-key header for convenience.

Body

application/json

Providing null clears the existing configuration. Either both fields should be supplied or both should be set to null.

webhookUrl
string<uri> | null
webhookSecret
string | null
Minimum string length: 8

Response

Webhook configuration updated

message
string
required
Example:

"Webhook configured successfully"