Replay Webhook

Add a webhook

/webhooks

POST https://api.terminal.africa/v1/webhooks/replay

Re-send a webhook notification. Queued asynchronously

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type	String	Set value to application/json

Request Body

Name	Type	Description
shipment_id	String	Required if delivery_id is not provided. Must be sent together with event.
delivery_id	String	Unique ID of a previous webhook delivery attempt (e.g. WD-9Z8Y7X6W5V4U3T2S). Required if shipment_id and event are not both provided. Use this to replay the exact stored payload from a specific delivery attempt.
event	String	Shipment webhook event to replay. Required if delivery_id is not provided. Must be sent together with shipment_id.
webhook_id	String	ID of a specific webhook endpoint (e.g. WA-1234567890ABCDEF). Limits replay to that URL instead of all endpoints subscribed to the event. Optional in all cases. Omit to replay to every active webhook subscribed to the event. If provided, that webhook must exist, be active, and be subscribed to the event being replayed. Otherwise the request fails.

200: Webhook replay queued successfully

{
  "status": true,
  "message": "Webhook replay queued successfully",
  "data": {
    "shipment_id": "SH-ABC123",
    "event": "shipment.delivered",
    "webhook_event_id": "WE-1A2B3C4D5E6F7G8H",
    "delivery_id": "WD-9Z8Y7X6W5V4U3T2S",
    "replay_mode": "stored_payload"
  }
}