Webhooks
Partially update webhook endpoint
Partially update an existing webhook endpoint configuration. Requires the Scale plan.
patch/v1/webhooks/{webhook_id}
Path parameters
webhook_idstring required
Example:wh_1a2b3c4d5e6f
Webhook endpoint ID
Request body
Example request
{
"url": "https://api.yourcompany.com/webhooks/oilpriceapi",
"events": [
"price.updated",
"drilling.rig_count.updated"
],
"active": true,
"description": "Production webhook for price updates"
}Response
Webhook endpoint updated successfully
Example response
{
"success": true,
"webhook": {
"id": "wh_1a2b3c4d5e6f",
"url": "https://api.yourcompany.com/webhooks/oilpriceapi",
"events": [
"price.updated",
"drilling.rig_count.updated"
],
"secret": "whsec_1234567890abcdef",
"active": true,
"created_at": "2025-08-10T10:30:00Z",
"updated_at": "2025-08-10T10:30:00Z",
"last_delivery": {
"attempted_at": "2025-08-10T12:00:00Z",
"status": "success",
"response_code": 200
}
}
}