Skip to main content
POST
Send a test delivery to an installation

Authorizations

Authorization
string
header
required

The dashboard's session token (Authorization: Bearer <JWT>), as the console sends it. Never paste it into a terminal: it opens every business the user belongs to.

Path Parameters

appId
string
required

One of your apps' ids. Another developer's app, or a malformed id, is 404 APP_NOT_FOUND.

Pattern: ^\d{1,20}$
installationId
string
required

An installation of this app. Another app's, or a malformed id, is 404 APP_INSTALLATION_NOT_FOUND.

Pattern: ^\d{1,20}$

Body

application/json
topic
enum<string>
required
Available options:
orders/created,
abandoned_checkouts/created,
orders/confirmed,
orders/cancelled,
orders/dispatched,
orders/delivered,
orders/returned,
orders/updated,
products/created,
products/updated,
products/deleted,
inventory_levels/updated,
customers/updated,
app/installed,
app/uninstalled,
app/scopes_updated,
customers/data_request,
customers/redact,
business/redact,
bulk/finished

Response

Whatever the endpoint answered.

data
object
required

What your endpoint answered to a test delivery.