Pause Status Webhook Handler
API Contract
REST
/api/v1/webhooks/pause-status
5 endpoints
GET
/api/v1/webhooks/pause-status/api/v1/webhooks/pause-status
List received webhook events for pause status changes
Auth Required
org_adminglobal_admin
Response Example
{
"data": [
{
"id": "wh_1a2b3c4d5e6f",
"source": "nhf_membership_system",
"event_type": "member.status.changed",
"old_status": "active",
"new_status": "paused",
"peer_mentor_id": "pm_551e8400",
"transition_direction": "PAUSE_ACTIVATED",
"payload_valid": true,
"received_at": "2026-03-19T14:29:55.000Z",
"processed_at": "2026-03-19T14:30:02.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1
}
}
GET
/api/v1/webhooks/pause-status/api/v1/webhooks/pause-status/:id
Get details of a specific received webhook event
Auth Required
org_adminglobal_admin
Response Example
{
"id": "wh_1a2b3c4d5e6f",
"source": "nhf_membership_system",
"event_type": "member.status.changed",
"raw_payload": {
"member_id": "pm_551e8400",
"old_status": "active",
"new_status": "paused",
"changed_at": "2026-03-19T14:29:50.000Z"
},
"old_status": "active",
"new_status": "paused",
"transition_direction": "PAUSE_ACTIVATED",
"peer_mentor_id": "pm_551e8400",
"payload_valid": true,
"received_at": "2026-03-19T14:29:55.000Z",
"processed_at": "2026-03-19T14:30:02.000Z"
}
POST
/api/v1/webhooks/pause-status/api/v1/webhooks/pause-status
Receive and process an inbound webhook event for pause status transitions (handleWebhookEvent)
Public
Request Example
{
"source": "nhf_membership_system",
"event_type": "member.status.changed",
"member_id": "pm_551e8400",
"old_status": "active",
"new_status": "paused",
"changed_at": "2026-03-19T14:29:50.000Z",
"signature": "sha256=abc123def456"
}
Response Example
{
"received": true,
"webhook_event_id": "wh_1a2b3c4d5e6f",
"transition_direction": "PAUSE_ACTIVATED",
"notifications_triggered": true
}
PUT
/api/v1/webhooks/pause-status/api/v1/webhooks/pause-status/:id
Mark a webhook event for reprocessing or update its metadata
Auth Required
org_adminglobal_admin
Request Example
{
"reprocess": true,
"notes": "Reprocessing due to downstream failure at initial receipt"
}
Response Example
{
"id": "wh_1a2b3c4d5e6f",
"reprocess_requested": true,
"reprocessed_at": "2026-03-26T09:30:00.000Z",
"status": "reprocessed"
}
DELETE
/api/v1/webhooks/pause-status/api/v1/webhooks/pause-status/:id
Delete a stored webhook event record
Auth Required
global_admin
Response Example
{
"message": "Webhook event record deleted",
"deleted_id": "wh_1a2b3c4d5e6f",
"deleted_at": "2026-03-26T09:35:00.000Z"
}