Get a webhook subscription
BuildingIn development for the v1 API. The contract is set; the route is not served yet.
Returns the subscription without secret; secret_last4 tells which secret signs and secret_rotating_until whether a previous one still does.
Needs the webhooks:read scope.
oauth2 webhooks:readAuthorizationBearer <token>OAuth 2.0 client credentials. Exchange your client_id and client_secret at /oauth/token of the environment for a bearer token valid for one hour. The playground of every operation asks for your own client and keeps it in your browser tab only.
Scope: webhooks:read
id*stringThe subscription id.
^whk_[0-7][0-9a-hjkmnp-tv-z]{25}$OK
application/json- response
id*string^whk_[0-7][0-9a-hjkmnp-tv-z]{25}$url*stringuridescription*stringevent_types*array<string>merchant_ids*array<>status*stringactive delivers; paused you set it and deliveries wait; disabled heru set it (see disabled_reason) and deliveries wait until you send status: active.
"active""paused""disabled"disabled_reason*|nulldisabled_at*|nullheaders*array<>secret?stringOnly in the answer of POST /webhooks and POST /webhooks/{id}/secret. Store it: it is never shown again.
^whsec_[A-Za-z0-9_-]{43}$secret_last4*stringsecret_rotating_until*|nullconsecutive_failures*integerFailed deliveries in a row. A 2xx resets it to zero.
failing_since*|nullenvironment*string"sandbox""production"created_at*stringdate-timeupdated_at*stringdate-timedeliveries*Where the delivery log of this subscription is.
curl -X GET 'https://api.dev.b2b.heru.app/v1/webhooks/whk_01m53g5zw414zt6vg08fqbacgm'{ "id": "whk_01m53g5zw414zt6vg08fqbacgm", "url": "https://partner.example.com/heru/webhooks", "description": "POS production", "event_types": [ "invoice.stamped", "charge.invoiced" ], "merchant_ids": [ "mer_01m4ra8wsyfh3s0tr4nrq3y96j" ], "status": "active", "disabled_reason": null, "disabled_at": null, "headers": [ { "name": "X-Partner-Token", "value": "****abcd" } ], "secret_last4": "L2Do", "secret_rotating_until": null, "consecutive_failures": 0, "failing_since": null, "environment": "production", "created_at": "2026-10-25T12:00:00.000Z", "updated_at": "2026-10-25T12:00:00.000Z", "deliveries": { "path": "/v1/webhooks/whk_01m53g5zw414zt6vg08fqbacgm/deliveries" }}List webhook subscriptionsGET
Every subscription of the company, most recent first, without `secret`. Needs the `webhooks:read` scope.
List deliveries of a subscriptionGET
Every delivery to the subscription, newest first, each with its attempts. Filter by status, event type, event id or when it was created. Needs the `webhooks:read` scope.