List a signup's notifications
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/signups/{id}/historyCosts 1 rate-limit point · Rate limits
List every notification sent for one back-in-stock signup, oldest first, with each channel's delivery events (sent, delivered, opened, clicked, bounced).
Each entry's id is a notification id for GET /back_in_stock/notifications/:id, which says whether that send was blocked and why. channels has one item per channel used, and its timestamps are null until the provider reports that event. provider is stoq for STOQ's own sending, or the integration's name (such as klaviyo or postscript) when one sent it. For the shop-wide send log, use GET /back_in_stock/notifications. An unknown signup id gives 404 not_found.
Also searched assignup historynotification historywhat was sent to this customerdid this customer get the restock email
Path parameters
idstringRequiredThe signup's ID, from
GET /back_in_stock/signups.
Returns
signup_idstringId of the signup acted on.
historyarray of objectsEvery notification sent for this signup, oldest first.
Show 8 child attributesHide child attributes
idstringNotification id.
sourcestringWhat sent it: the restock send's source (see trigger_source) when one started it, else how it was sent (campaign_template, send or resend from one signup row).
trigger_sourcenullSource of the restock or bulk send that sent it (webhook, bulk_send, bulk_resend, flow_action, ...); null when it was sent on its own.
template_positionintegerWhich message of the alert sequence this was: 0 is the back-in-stock alert, higher numbers are reminders.
notified_atnullWhen the notification was sent; null when it was not sent, for example blocked by the plan limit.
created_atstringWhen the notification was created.
triggered_atnullWhen the restock or bulk send that sent it started; null when it was sent on its own.
channelsarray of objectsThe message sent on each channel, with its delivery events.
Show 8 child attributesHide child attributes
typestringChannel of this message.
One ofemailsmssent_atnullWhen the provider accepted the message; null if not yet.
delivered_atnullWhen the message was delivered; null if not (yet) reported.
opened_atnullWhen the email was first opened; null if not opened. Email only.
clicked_atnullWhen a link in the message was first clicked; null if never.
bounced_atnullWhen the email bounced; null if it did not. Email only.
providerstringWho delivered the message: stoq for STOQ's own senders, else the integration (klaviyo, flow, postscript).
provider_fallback_reasonstring, nullableWhy the merchant's chosen provider was not used (e.g. credentials_missing, flow_unverified); null when it was.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe request failed validation.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string/history" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string/history", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string/history",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/signups/string/history")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"signup_id": "string",
"history": [
{
"id": "string",
"source": "string",
"trigger_source": null,
"template_position": 1,
"notified_at": null,
"created_at": "2026-01-15T09:30:00Z",
"triggered_at": null,
"channels": [
{
"type": "email",
"sent_at": null,
"delivered_at": null,
"opened_at": null,
"clicked_at": null,
"bounced_at": null,
"provider": "string",
"provider_fallback_reason": "string"
}
]
}
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}