Skip to main content
POST
/
v2
/
webhooks
/
{webhook_id}
/
stop
Stop Monitoring
curl --request POST \
  --url https://api.example.com/v2/webhooks/{webhook_id}/stop \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "webhook_id": "6789abcdef0123456789abcd",
    "account_id": "69c127c37cae0494dd827286",
    "monitoring": false
  },
  "metadata": {
    "action": "stop_webhook",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Stop real-time monitoring for a webhook’s associated account. No more events will be sent to the webhook URL.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Path Parameters

​
webhook_id
string
required
The unique identifier of the webhook to stop monitoring for

​
Response

​
success
boolean
Whether monitoring was stopped successfully
​
data
object
{
  "success": true,
  "data": {
    "webhook_id": "6789abcdef0123456789abcd",
    "account_id": "69c127c37cae0494dd827286",
    "monitoring": false
  },
  "metadata": {
    "action": "stop_webhook",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}

​
Notes

  • Credit consumption stops when monitoring is stopped
  • You can restart monitoring at any time by calling /v2/webhooks/{webhook_id}/start
  • The webhook configuration is preserved — only monitoring is stopped