Skip to main content
POST
/
v2
/
webhooks
/
{webhook_id}
/
start
Start Monitoring
curl --request POST \
  --url https://api.example.com/v2/webhooks/{webhook_id}/start \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "webhook_id": "6789abcdef0123456789abcd",
    "account_id": "69c127c37cae0494dd827286",
    "monitoring": true
  },
  "metadata": {
    "action": "start_webhook",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Begin real-time monitoring for a webhook’s associated account. Events will be sent to the webhook URL as they occur.
Monitoring consumes 10 credits per day per active account (1 credit every 144 minutes). Credit consumption begins as soon as monitoring starts.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Path Parameters

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

​
Response

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

​
Notes

  • The account must be in a connected state for monitoring to start
  • If monitoring is already active for this account (via another webhook), it will not create a duplicate connection
  • If the account’s token expires during monitoring, you will receive a disconnection event on your webhook URL
  • You need at least 1 credit available to start monitoring