Webhooks
Get webhook endpoint
Returns a single webhook endpoint by ID. Ownership is verified against the caller scope. The signing secret is never returned on read — use POST .../rotate-secret to generate a new one.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
curl -X GET "https://api.miracle.com/v1/webhooks/endpoints/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"
],
"status": "active",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": null
}
}Empty
Delete webhook endpoint
Soft-deletes a webhook endpoint — deliveries stop immediately. The record is preserved for audit (deletedAt is set). Issue a new endpoint if you need to resume deliveries.
List webhook endpoints
Returns webhook endpoints owned by the caller scope. Merchant callers see only their own endpoints; tenant/platform callers see endpoints at their owner level. Signing secrets are never included in list responses.