Skip to main content
Updatable Fields
  • events: Change which events trigger webhooks
  • enabled: Enable or disable the endpoint
  • description: Update the description
The URL cannot be updated. Create a new endpoint if you need a different URL.
PATCH
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
Update a webhook endpoint
curl --request PATCH \
  --url https://api.peepal.dev/v1/webhooks/endpoints/{endpoint_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "events": [
    "job.created"
  ],
  "enabled": true,
  "description": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "job.created"
  ],
  "enabled": true,
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
Update the configuration of an existing webhook endpoint. You can modify events, enable/disable status, and description. 
curl -X PATCH "https://api.peepal.dev/v1/webhooks/endpoints/wh_01ARZ3NDEKTSV4RRFFQ69G5FAV" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "events": ["job.completed", "job.failed", "job.started"],
    "enabled": true
  }'

{
  "id": "wh_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "url": "https://your-app.com/webhooks/peepal",
  "events": ["job.completed", "job.failed", "job.started"],
  "enabled": true,
  "description": "Production webhook endpoint",
  "created_at": "2025-12-31T10:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
endpoint_id
string
required

Body

application/json
​
events
enum<string>[]
Available options:
job.created,
job.started,
job.progress,
job.completed,
job.failed,
job.canceled
​
enabled
boolean
​
description
string

Response

Webhook endpoint updated

​
id
string
required
​
url
string<uri>
required
​
events
enum<string>[]
required
Available options:
job.created,
job.started,
job.progress,
job.completed,
job.failed,
job.canceled
​
enabled
boolean
required
​
description
string | null
required
​
created_at
string<date-time>
required