Admin webhooks
Create webhook endpoint (admin)
Admin variant of POST /v1/webhooks/endpoints. Creates a webhook endpoint at the tenant or platform level based on the caller context. Signing secret is returned ONCE in this response — store it securely. URL must use HTTPS.
Authorization
bearer AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://api.miracle.com/v1/admin/webhook-endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "events": [ "string" ] }'{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ownerType": "merchant",
"ownerId": "string",
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
"url": "http://example.com",
"description": "string",
"events": [
"string"
],
"secret": "string",
"status": "active",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": null
}
}Empty
Empty
List webhook delivery records (admin)
Admin variant of GET /v1/webhooks/deliveries. Scoped by tenantId only — returns all delivery records in the tenant. Optional `endpoint_id` narrows further. Cursor-based pagination via `cursor` + `limit`.
Delete webhook endpoint (admin)
Admin variant of DELETE /v1/webhooks/endpoints/:id. Soft-deletes the endpoint — deliveries stop immediately. The record is preserved for audit.