Skip to main content
Use this to verify endpoint configuration and check which events are subscribed.
GET
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
Get a webhook endpoint
curl --request GET \
  --url https://api.peepal.dev/v1/webhooks/endpoints/{endpoint_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "job.created"
  ],
  "enabled": true,
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
Retrieve the details of a specific webhook endpoint.
curl -X GET "https://api.peepal.dev/v1/webhooks/endpoints/wh_01ARZ3NDEKTSV4RRFFQ69G5FAV" \
  -H "x-api-key: YOUR_API_KEY"
{
  "id": "wh_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "url": "https://your-app.com/webhooks/peepal",
  "events": ["job.completed", "job.failed"],
  "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

Response

Webhook endpoint details

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