Edit Monitor Webhook URL - API Reference

Updates a single monitor’s settings. You can change its webhook_url, and — for search monitors — its refresh_frequency.

Updating webhook_url only affects this one monitor and does not change your global webhook URL. When a monitor-specific webhook is not set, its webhook requests are routed to your global webhook URL.

PATCH https://api.socialdata.tools/monitors/{monitor_id}

Headers

Authorization string required

Authorization Bearer header containing your SocialData API key

Example: Bearer YOUR_API_KEY

Path Parameters

monitor_id string required

Target monitor ID

Example: 01jeg76qa91b095gttamsbwa6q

Body

webhook_url string optional

Webhook URL for this monitor only. Pass an empty value to remove the monitor-specific webhook and fall back to your global webhook URL

Example: https://my-website.com/webhook or NULL

refresh_frequency integer optional

Search monitors only. How often the monitor executes, in seconds (value between 1 and 3600). Sending this for any other monitor type returns a validation error. Changing it changes what the monitor costs — see Pricing

Example: 300

The new frequency takes effect from the monitor’s next execution.

Code Examples

curl -X PATCH "https://api.socialdata.tools/monitors/01jeg76qa91b095gttamsbwa6q" \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{"webhook_url": "https://my-website.com/webhook"}'

const monitorId = '01jeg76qa91b095gttamsbwa6q';
const API_KEY = 'YOUR_API_KEY_HERE';
const webhookUrl = 'https://my-website.com/webhook';

fetch(`https://api.socialdata.tools/monitors/${monitorId}`, {
    method: 'PATCH',
    headers: {
        'Authorization': `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    },
    body: JSON.stringify({ webhook_url: webhookUrl })
})
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));

import requests

monitor_id = '01jeg76qa91b095gttamsbwa6q'
API_KEY = 'YOUR_API_KEY_HERE'
webhook_url = 'https://my-website.com/webhook'

url = f'https://api.socialdata.tools/monitors/{monitor_id}'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json',
    'Accept': 'application/json'
}

payload = {'webhook_url': webhook_url}

response = requests.patch(url, json=payload, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

$monitor_id = '01jeg76qa91b095gttamsbwa6q';
$API_KEY = 'YOUR_API_KEY_HERE';
$webhook_url = 'https://my-website.com/webhook';

$url = "https://api.socialdata.tools/monitors/{$monitor_id}";

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_POSTFIELDS => json_encode(['webhook_url' => $webhook_url]),
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $API_KEY",
        "Content-Type: application/json",
        "Accept: application/json"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
print_r($data);

curl_close($ch);

Example Responses

{
  "status": "success",
  "data": {
    "id": "01jksy1wv06r3jgk8d0bzahhwg",
    "created_at": "2025-02-11T07:19:53.000000Z",
    "monitor_type": "user_profile",
    "webhook_url": "https://my-website.com/webhook", // contains new webhook_url or null
    "parameters": {
      "user_screen_name": "MarioNawfal",
      "user_name": "Mario Nawfal",
      "user_id_str": "1319287761048723458"
    }
  }
}

{
    "status": "error",
    "message": "Not found"
}

Response Codes

200 OK - request succeeded
404 Not Found - requested monitor does not exist