Send Test Dropship Webhook
POST/api/admin/portal/accounts/:customer/webhooks/:webhook/test
Send a signed test event to the endpoint right now and return the logged delivery. Test events are sent once (never retried) and never count toward the auto-disable threshold, and they are sent even when the endpoint is switched off. Requires the portal.manage permission; limited to 20 requests per minute. No request body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
A 200 response means the attempt was made — check status and response_status for whether the endpoint accepted it.
Delivery fields: status is delivered (a 2xx was received), retrying (failed, another attempt is scheduled at next_retry_at), failed (no attempts left) or pending (not attempted yet). response_status / response_body are from the last attempt (body truncated to 2048 characters; on a connection error response_status is null and the body holds the error). payload is the exact JSON body sent; retailer_order_number and sales_order_number are lifted from it (null for test events).
Errors. 404 when the webhook does not belong to the account.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.