Webhook CallBack
Overview
Bulk API webhook configuration with batch event processing support.
Endpoint Details
| HTTP Method | POST |
|---|---|
| Endpoint Path | /v2/settings/addWebhook |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| url | String (URL) | Yes | HTTPS endpoint where webhook events will be sent via POST request | https://yourapp.com/webhooks/email-events |
| event | String | No | Comma-separated list of events to track: send,open,click,soft_bounce,hard_bounce,spam | send,open,click |
| description | String | No | Human-readable description for this webhook configuration | Production webhook for email tracking |
| store_log | String | No | Whether to store webhook delivery logs. Values: "Enable" or "Disable" | Enable |
Request Example
Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.
{
"owner_id": "{USER_ID}",
"url": "https://app.us.sendclean.net/api/report/mtaReports",
"event": "send,open,click,soft_bounce,hard_bounce,spam,suppression",
"description": "sendclean webhook",
"store_log": "Enable",
"isNewProcess": "Y"
}Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Resource created successfully",
"data": {
"id": "resource_abc123",
"created_at": "2026-04-17T10:30:00Z"
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Implementation Examples
curl -X POST \
https://api.sendclean.com/v2/settings/addWebhook \
-H 'Content-Type: application/json' \
-d '{
"owner_id": "{USER_ID}",
"url": "https://app.us.sendclean.net/api/report/mtaReports",
"event": "send,open,click,soft_bounce,hard_bounce,spam,suppression",
"description": "sendclean webhook",
"store_log": "Enable",
"isNewProcess": "Y"
}'const axios = require('axios');
const url = 'https://api.sendclean.com/v2/settings/addWebhook';
const payload = {
"owner_id":"{USER_ID}",
"url":"https://app.us.sendclean.net/api/report/mtaReports",
"event":"send,open,click,soft_bounce,hard_bounce,spam,suppression",
"description":"sendclean webhook",
"store_log":"Enable",
"isNewProcess": "Y"
} ;
axios.post(url, payload, {
headers: {
'Content-Type': 'application/json'
}
})
.then(response => {
console.log('Success:', response.data);
})
.catch(error => {
console.error('Error:', error.response ? error.response.data : error.message);
});<?php
$url = 'https://api.sendclean.com/v2/settings/addWebhook';
$payload = json_decode('{
"owner_id":"{USER_ID}",
"url":"https://app.us.sendclean.net/api/report/mtaReports",
"event":"send,open,click,soft_bounce,hard_bounce,spam,suppression",
"description":"sendclean webhook",
"store_log":"Enable",
"isNewProcess": "Y"
} ', true);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json'
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpCode == 200) {
$result = json_decode($response, true);
print_r($result);
} else {
echo "Error: $httpCode - $response";
}
?>Overview
Bulk API webhook listing with enhanced delivery metrics.
Endpoint Details
| HTTP Method | GET |
|---|---|
| Endpoint Path | /v2/settings/listWebhook |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
Response Format
Successful Response:
{
"status": "success",
"code": 200,
"data": {
"items": [
{
"id": "item_001",
"created_at": "2026-04-01T09:00:00Z",
"status": "active"
}
],
"total": 1,
"page": 0
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Overview
Bulk API webhook modification with additional batch processing options.
Endpoint Details
| HTTP Method | PUT |
|---|---|
| Endpoint Path | /v2/settings/editWebhook |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| url | String (URL) | Yes | HTTPS endpoint where webhook events will be sent via POST request | https://yourapp.com/webhooks/email-events |
| event | String | No | Comma-separated list of events to track: send,open,click,soft_bounce,hard_bounce,spam | send,open,click |
| description | String | No | Human-readable description for this webhook configuration | Production webhook for email tracking |
| store_log | String | No | Whether to store webhook delivery logs. Values: "Enable" or "Disable" | Enable |
| webhook_id | String | Yes | Unique identifier of the webhook configuration to modify or query | wh_abc123 |
Request Example
Below is a complete example of the request body. Replace placeholder values with your actual credentials and data.
{
"owner_id": "{USER_ID}",
"webhook_id": "{{webhook_id}}",
"url": "https://email-api.masivapp.com/email/external-sendclean-events/EventMapper",
"event": "send,open,click,soft_bounce,hard_bounce,spam,suppression",
"description": "sendclean webhook",
"store_log": "Disable",
"isNewProcess": "Y"
}Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Resource updated successfully",
"data": {
"updated_at": "2026-04-17T10:30:00Z"
}
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Overview
Bulk API webhook details with extended delivery analytics.
Endpoint Details
| HTTP Method | GET |
|---|---|
| Endpoint Path | /v2/settings/getWebhookInfo |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| webhook_id | String | Yes | Unique identifier of the webhook configuration to modify or query | wh_abc123 |
Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Operation completed successfully"
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Overview
Bulk API webhook deletion with confirmation safeguards.
Endpoint Details
| HTTP Method | DELETE |
|---|---|
| Endpoint Path | /v2/settings/deleteWebhook |
| API Version | Bulk API (v2.0) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| owner_id | String | Yes | Your unique SendClean account identifier | user_12345 |
| webhook_id | String | Yes | Unique identifier of the webhook configuration to modify or query | wh_abc123 |
Response Format
Successful Response:
{
"status": "success",
"code": 200,
"message": "Resource deleted successfully"
}Common Errors & Troubleshooting
401 - Unauthorized: Authentication credentials are missing or invalid
Solution: Verify owner_id and token are correct. Ensure they match your account credentials exactly with no extra whitespace.
500 - Internal server error: Unexpected server error occurred
Solution: Retry the request after a brief delay. If error persists, contact SendClean support with the request details and timestamp.
Updated 2 months ago