Create Dropship Webhook
POST/api/admin/portal/accounts/:customer/webhooks
Register a webhook endpoint for the account. Requires the portal.manage permission. Returns 201 with the subscription plus its signing secret — the only time the secret is returned; store it now (use Rotate Dropship Webhook Secret if it is lost).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request fields
url(string, required, max 1024): fullhttps://URL that resolves to a public address.events(array of strings, optional): any ofdropship_order.created,dropship_order.shipped,dropship_order.cancelled,dropship_order.on_hold. Omitted or empty subscribes to all of them.active(boolean, optional, default true).
Errors. 422 when the URL is not HTTPS, malformed, or resolves to a private/internal address, or an event name is unknown.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
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.