Webhook API Reference

Test Webhook

Send a test event to a webhook endpoint.

Queues the built-in test/webhook event for an active endpoint and returns before it is delivered. A paused or inactive endpoint returns 400.

POST
/shipos/webhooks/{webhook_id}/test
x-access-token<token>

In: header

Path Parameters

webhook_id*string

ID of the webhook endpoint

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/shipos/webhooks/string/test"
{  "success": true,  "message": "string",  "status_code": 0.1,  "event_type": "string",  "timestamp": "string"}