Webhook Endpoints API — Register & Manage URLs
Pre-register and manage webhook endpoint URLs for tracking notifications. Test endpoints, rotate signing secrets, monitor delivery health, retry failed deliveries.
Overview
Pre-register a URL to receive webhooks. Registered endpoints can be referenced by webhookEndpointId during webhook registration. Free API - does not count towards usage quota.
Example Request
// npm install whereparcel
import { WhereParcel } from 'whereparcel';
const wp = new WhereParcel('YOUR_API_KEY', 'YOUR_SECRET_KEY');
const endpoint = await wp.createWebhookEndpoint({
"name": "Production Webhook",
"url": "https://myapp.com/webhooks/whereparcel",
"description": "Production webhook receiver URL"
});
console.log(endpoint); curl -X POST https://api.whereparcel.com/v2/webhook-endpoints \
-H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Webhook",
"url": "https://myapp.com/webhooks/whereparcel",
"description": "Production webhook receiver URL"
}' const response = await fetch('https://api.whereparcel.com/v2/webhook-endpoints', {
method: 'POST',
headers: {
"Authorization": "Bearer YOUR_API_KEY:YOUR_SECRET_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Production Webhook",
"url": "https://myapp.com/webhooks/whereparcel",
"description": "Production webhook receiver URL"
})
});
const data = await response.json();
console.log(data); <?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.whereparcel.com/v2/webhook-endpoints'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST'); $headers = [ 'Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY', 'Content-Type: application/json' ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $data = [ 'name' => "Production Webhook", 'url' => "https://myapp.com/webhooks/whereparcel", 'description' => "Production webhook receiver URL" ]; curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); print_r($result);
import requests
url = 'https://api.whereparcel.com/v2/webhook-endpoints'
headers = {
'Authorization': 'Bearer YOUR_API_KEY:YOUR_SECRET_KEY',
'Content-Type': 'application/json'
}
data = {
'name': "Production Webhook",
'url': "https://myapp.com/webhooks/whereparcel",
'description': "Production webhook receiver URL"
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result) package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.whereparcel.com/v2/webhook-endpoints"
payload := []byte(`{"name":"Production Webhook","url":"https://myapp.com/webhooks/whereparcel","description":"Production webhook receiver URL"}`)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Add("Authorization", "Bearer YOUR_API_KEY:YOUR_SECRET_KEY")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
} Replace the test API key with your actual API key from the dashboard.
Request Body
name string · required | |
url string · required | |
secret string | |
description string |
Response
Success Response (201)
{
"success": true,
"data": {
"endpointId": "wep_a1b2c3d4e5f6",
"name": "Production Webhook",
"url": "https://myapp.com/webhooks/whereparcel",
"secret": "whsec_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456",
"description": "Production webhook receiver URL",
"isActive": true,
"createdAt": "2026-02-05T10:00:00.000Z"
}
} Error Response (400)
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "The request parameters are invalid"
}
} Error Response (401)
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
} Error Response (409)
{
"success": false,
"error": {
"code": "DUPLICATE_URL",
"message": "This webhook URL is already registered"
}
} Overview
Retrieve all registered webhook endpoints. Free API - does not count towards usage quota.
Example Request
// npm install whereparcel
import { WhereParcel } from 'whereparcel';
const wp = new WhereParcel('YOUR_API_KEY', 'YOUR_SECRET_KEY');
const endpoints = await wp.getWebhookEndpoints();
console.log(endpoints); curl -X GET https://api.whereparcel.com/v2/webhook-endpoints \ -H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \ -H "Content-Type: application/json"
const response = await fetch('https://api.whereparcel.com/v2/webhook-endpoints', {
method: 'GET',
headers: {
"Authorization": "Bearer YOUR_API_KEY:YOUR_SECRET_KEY",
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data); <?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.whereparcel.com/v2/webhook-endpoints'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); $headers = [ 'Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY', 'Content-Type: application/json' ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); print_r($result);
import requests
url = 'https://api.whereparcel.com/v2/webhook-endpoints'
headers = {
'Authorization': 'Bearer YOUR_API_KEY:YOUR_SECRET_KEY',
'Content-Type': 'application/json'
}
response = requests.get(url, headers=headers)
result = response.json()
print(result) package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.whereparcel.com/v2/webhook-endpoints"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY:YOUR_SECRET_KEY")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
} Replace the test API key with your actual API key from the dashboard.
Response
Success Response (200)
{
"success": true,
"data": [
{
"endpointId": "wep_a1b2c3d4e5f6",
"name": "Production Webhook",
"url": "https://myapp.com/webhooks/whereparcel",
"description": "Production webhook receiver URL",
"isActive": true,
"createdAt": "2026-02-05T10:00:00.000Z",
"updatedAt": "2026-02-05T10:00:00.000Z"
},
{
"endpointId": "wep_a1b2c3d4e5f6",
"name": "Staging Webhook",
"url": "https://staging.myapp.com/webhooks/whereparcel",
"description": "Staging webhook receiver URL",
"isActive": false,
"createdAt": "2026-02-04T15:30:00.000Z",
"updatedAt": "2026-02-04T16:00:00.000Z"
}
]
} Error Response (401)
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
} Overview
Update webhook endpoint information. You can change the URL, name, description, active status, etc. Free API - does not count towards usage quota.
Example Request
// npm install whereparcel
import { WhereParcel } from 'whereparcel';
const wp = new WhereParcel('YOUR_API_KEY', 'YOUR_SECRET_KEY');
const endpoint = await wp.updateWebhookEndpoint('wep_a1b2c3d4e5f6', {
"name": "Updated Webhook Name",
"url": "https://myapp.com/webhooks/new-url",
"isActive": true
});
console.log(endpoint); curl -X PUT https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6 \
-H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Webhook Name",
"url": "https://myapp.com/webhooks/new-url",
"isActive": true
}' const response = await fetch('https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6', {
method: 'PUT',
headers: {
"Authorization": "Bearer YOUR_API_KEY:YOUR_SECRET_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Updated Webhook Name",
"url": "https://myapp.com/webhooks/new-url",
"isActive": true
})
});
const data = await response.json();
console.log(data); <?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT'); $headers = [ 'Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY', 'Content-Type: application/json' ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $data = [ 'name' => "Updated Webhook Name", 'url' => "https://myapp.com/webhooks/new-url", 'isActive' => true ]; curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); print_r($result);
import requests
url = 'https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6'
headers = {
'Authorization': 'Bearer YOUR_API_KEY:YOUR_SECRET_KEY',
'Content-Type': 'application/json'
}
data = {
'name': "Updated Webhook Name",
'url': "https://myapp.com/webhooks/new-url",
'isActive': True
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
print(result) package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6"
payload := []byte(`{"name":"Updated Webhook Name","url":"https://myapp.com/webhooks/new-url","isActive":true}`)
req, _ := http.NewRequest("PUT", url, bytes.NewBuffer(payload))
req.Header.Add("Authorization", "Bearer YOUR_API_KEY:YOUR_SECRET_KEY")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
} Replace the test API key with your actual API key from the dashboard.
Path Parameters
endpointId string · required | <p>Endpoint ID to update</p>
wep_a1b2c3d4e5f6 |
Request Body
name string | |
url string | |
description string | |
isActive boolean |
Response
Success Response (200)
{
"success": true,
"data": {
"endpointId": "wep_a1b2c3d4e5f6",
"name": "Updated Webhook Name",
"url": "https://myapp.com/webhooks/new-url",
"description": "Updated description",
"isActive": true,
"updatedAt": "2026-02-05T11:00:00.000Z"
}
} Error Response (400)
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "At least one field must be provided"
}
} Error Response (401)
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
} Error Response (404)
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found"
}
} Error Response (409)
{
"success": false,
"error": {
"code": "DUPLICATE_URL",
"message": "This webhook URL is already registered"
}
} Overview
Delete a webhook endpoint. Cannot delete an endpoint that is in use by active webhooks. Free API - does not count towards usage quota.
Example Request
// npm install whereparcel
import { WhereParcel } from 'whereparcel';
const wp = new WhereParcel('YOUR_API_KEY', 'YOUR_SECRET_KEY');
const result = await wp.deleteWebhookEndpoint('wep_a1b2c3d4e5f6');
console.log(result); curl -X DELETE https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6 \ -H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \ -H "Content-Type: application/json"
const response = await fetch('https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6', {
method: 'DELETE',
headers: {
"Authorization": "Bearer YOUR_API_KEY:YOUR_SECRET_KEY",
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data); <?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE'); $headers = [ 'Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY', 'Content-Type: application/json' ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); curl_close($ch); $result = json_decode($response, true); print_r($result);
import requests
url = 'https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6'
headers = {
'Authorization': 'Bearer YOUR_API_KEY:YOUR_SECRET_KEY',
'Content-Type': 'application/json'
}
response = requests.delete(url, headers=headers)
result = response.json()
print(result) package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.whereparcel.com/v2/webhook-endpoints/wep_a1b2c3d4e5f6"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY:YOUR_SECRET_KEY")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
} Replace the test API key with your actual API key from the dashboard.
Path Parameters
endpointId string · required | <p>Endpoint ID to delete</p>
wep_a1b2c3d4e5f6 |
Response
Success Response (200)
{
"success": true,
"data": {
"deleted": true,
"endpointId": "wep_a1b2c3d4e5f6",
"message": "Webhook endpoint deleted successfully"
}
} Error Response (401)
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
} Error Response (404)
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found"
}
} Error Response (409)
{
"success": false,
"error": {
"code": "ERROR",
"message": "An error occurred"
}
}