Simulate Webhook

/webhooks

POST https://sandbox.terminal.africa/v1/webhooks/simulate

Queue a webhook notification using the current data for a real resource. Delivery is asynchronous (same path as live webhooks).

Headers

Staging only. This endpoint is not available in production. Use it to fire a webhook event from a live resource you own, without changing that resource’s status.

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

Request Body

Name	Type	Description
event	String	Webhook event to simulate. Required if events is not provided. Must be one of the supported webhook events.
events	Array of String	List of webhook events to simulate in one request. Required if event is not provided. Each event must include the matching resource ID below.
shipment_id	String	Required for shipment.*, reconciliation.*, and regulatory_document.* events.
address_id	String	Required for address.* events.
packaging_id	String	Required for packaging.* events.
insurance_id	String	Required for insurance.* events.
claim_id	String	Required for claim.* events.
transaction_id	String	Required for transaction.* events. Use the wallet transactionId.
webhook_id	String	ID of a specific webhook endpoint (e.g. WA-1234567890ABCDEF). Optional. If provided, that webhook must exist, be active, and be subscribed to the event being simulated. Otherwise the request fails.

Resource requirements by event

Event(s)	Required field
address.created, address.updated, address.deleted	address_id
packaging.created, packaging.updated	packaging_id
shipment.created, shipment.updated, shipment.in-transit, shipment.delivered, shipment.cancelled	shipment_id
insurance.success, insurance.failed	insurance_id
claim.success, claim.failed	claim_id
transaction.success, transaction.failed	transaction_id
reconciliation.flagged, reconciliation.billed	shipment_id
regulatory_document.pending, regulatory_document.uploaded, regulatory_document.complete	shipment_id

You must own the resource, and you must have at least one active webhook subscribed to the event. Simulation does not update the resource (for example, it will not mark a shipment as delivered).

Example request

{
  "event": "shipment.delivered",
  "shipment_id": "SH-ABC123"
}

Example request (multiple events)

{
  "events": ["transaction.success", "transaction.failed"],
  "transaction_id": "TXN-9Z8Y7X6W5V4U3T2S"
}

200: Webhook simulation queued successfully

{
  "status": true,
  "message": "Webhook simulation queued successfully",
  "data": {
    "results": [
      {
        "event": "shipment.delivered",
        "resource_type": "shipment",
        "resource_id": "SH-ABC123",
        "queued": true
      }
    ]
  }
}