Delete a webhook endpoint
/api/v1alpha1/webhooks/{webhook_id}Deletes a webhook endpoint and stops all further deliveries to it.
- Access: an alpha-enabled API key with the
MANAGE_WEBHOOKSpermission. - Response: no body.
- Retries:
Idempotency-Keyapplies to POST endpoints only, so repeating a DELETE is not deduplicated. - Not found: an endpoint in another workspace is deliberately indistinguishable from one that does not exist.
Once the endpoint is gone its delivery history can no longer be read through this API, so export anything you need for audit first.
Authorization
apiKey In: header
Path Parameters
Identifier of a registered webhook endpoint.
Response Body
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/api/v1alpha1/webhooks/wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"Update a webhook endpoint PATCH
Changes a webhook endpoint: its URL, which events it receives, its description, or whether it is enabled.
List webhook deliveries GET
Returns the delivery attempts DeepFrame has made to one endpoint, newest first. This is where you look when an endpoint stops receiving events.