Skip to content
BolderBolder Developers
Esc
↑↓navigate↵open⌘Jpreview

List the alert topics a notification profile can opt in to

The topics that raise alerts, with the Spanish label and description to show them. The same for every account, so it needs no user token. profile_entry is the value a notification profile entry holds to opt a recipient in to that topic’s alert emails (the canonical spelling, the one Alert#kind has); topic is the same topic in the v2 spelling an alert shows. Topics that only resolve an alert (product.restocked, integration.recovered) are not listed.

GET/alerts/topics
Authorization
AuthorizationBearer token (JWT) · headerrequired
Responses
200

Alert topics

403

The token has no shops.read

Try it
Server
Authorization
Request
curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/alerts/topics"
Response
{
  "total_items": 2,
  "_embedded": {
    "items": [
      {
        "topic": "integration.misconfigured",
        "profile_entry": "integrations.misconfigured",
        "label": "Integración mal configurada",
        "description": "Una integración de tu tienda dejó de funcionar: falta un dato requerido o el servicio rechazó las credenciales"
      },
      {
        "topic": "product.sold_out",
        "profile_entry": "products.sold_out",
        "label": "Producto agotado",
        "description": "Un producto se quedó sin stock"
      }
    ]
  }
}

Was this page helpful?