Skip to navigation
API ReferenceWebhooks

Send a test delivery

Available by request

Webhooks are only available for certain clients. Contact your Rush Order representative to have them enabled. Creating or changing subscriptions with an API key must also be enabled for your account; otherwise this returns 403.

Sends a signed webhook.test delivery to the subscription’s destination right away and reports how your endpoint responded. It is a single attempt with a 10-second limit, and can be sent at most once every 10 seconds per subscription.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idintegerRequired
The subscription ID.

Headers

RushOrderMomCodestringRequired
All requests require the header to contain RushOrderMomCode, a 3 character string that represents the client internally in Rush Order. This should be given to you by Rush Order.

Response

The test was attempted. Check Delivered for the outcome.

DeliveredbooleanOptional
True when your endpoint returned a 2xx status.
StatusCodeinteger or nullOptional
Your endpoint's HTTP status code.
ElapsedMillisecondslongOptional
ResponseSnippetstring or nullOptional
The start of your endpoint's response body, up to 512 characters.
Errorstring or nullOptional
Why the delivery failed, when it did.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error