Ctrl+K

Suspend a webhook

post/api/v2/internal/webhook/{webhookId}/suspend

Internal API for NCC to suspend a webhook and notify admins. This endpoint updates the webhook state to 'suspended' and sends email notifications to all relevant admin users.

Path Parameters

  • webhookIdstringRequired
    Webhook public id
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

reason string required
The reason for suspending the webhook (e.g., "High failure count", "Suspicious behavior")
Min length: >= 1 characters
suspendedBy string required
The entity that initiated the suspension (e.g., "NCC")
Min length: >= 1 characters

200 Response

webhookId string required
state string required
Allowed value: suspended
reason string required
suspendedAt string required
notificationsSent number required
admins array[string] required

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

409 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id