List webhook subscriptions

Every subscription on the tenant. The HMAC secret is never included — it is revealed once, at create time. Use this to audit which URLs are listening, and to look up a whsub_… for deletion.

failureCount is consecutive failed deliveries; it resets on the next success. A subscription with a high count and an old lastDeliveryAt is one whose endpoint has been down.

GET/api/v1/webhooks

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Query parameters

fieldsstring

Comma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

Responses

200OK

itemsWebhookSubscription[]required

Show properties

Array of WebhookSubscription

idstringrequired

urlstringrequired

eventsstring[]required

activebooleanrequired

createdAtinteger<int64>required

Unix ms when this subscription was created.

lastDeliveryAtinteger<int64> | null

Unix ms of the most recent delivery attempt, or `null` if nothing has been delivered yet.

failureCountinteger

Count of consecutive failed deliveries since the last success.

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

fieldsqueryComma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

Request

curl -X GET "https://app.bloomcount.com/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bloomcount.com/api/v1/webhooks", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.bloomcount.com/api/v1/webhooks",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "id": "whsub_88h3k4l5m6n7p8q9r0s1t2u",
      "url": "https://example.com/hooks/petals",
      "events": [
        "event.created",
        "event.updated"
      ],
      "active": true,
      "createdAt": 1809456000000,
      "lastDeliveryAt": 1810123456789,
      "failureCount": 0
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}