OpenAPI reference · Webhooks
Delete webhook endpoint
/webhook-endpoints/{endpointId}Permanently remove an endpoint. In-flight deliveries continue
until they terminate (DELIVERED or FAILED_PERMANENT);
new events stop fanning out immediately. Idempotent — repeated
deletes return the same shape.
Requires the webhooks:manage scope.
Authorization
AuthorizationstringrequiredBearer token in the Authorization header.
Pass
Authorization: Bearer scripe_sk_live_<...>(orscripe_sk_test_<...>for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.The same header also accepts an OAuth 2.1 access token (
scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface exceptwebhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer403 scope_missingto every API key. Operations that name no scope accept any valid token of the workspace.
Path parameters
endpointIdstringrequired
Header parameters
Scripe-Api-VersionstringPin the API version. Format
YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return400 version_unsupported.
Responses
- 200
Endpoint deleted.
- 401
Missing, malformed, expired, or revoked API key.
- 403
Plan not eligible, scope missing, or workspace mismatch.
- 404
Resource not found in this workspace.
- 429
Sliding-window rate limit exceeded.
Example request
curl --request DELETE \
--url 'https://api.scripe.io/v1/webhook-endpoints/{endpointId}' \
--header 'Authorization: Bearer <token>'Example response (200)
{
"data": {
"id": "string",
"deleted": true
}
}