Get a trigger subscription
Returns one trigger subscription: the routine trigger it serves, the exact pack trigger version, the configuration and connections bound at publish, and its status (`failed` with `error` when subscribing at the provider failed; B3OS retries).
GET
/v1/actions/subscriptions/{subscription_id}
Returns one trigger subscription: the routine trigger it serves, the exact pack trigger version, the
configuration and connections bound at publish, and its status (`failed` with `error` when subscribing at
the provider failed; B3OS retries).
Authentication
Bearer Token (b3os_sk_ API key or b3os_pat_ token) API Key (cookie: __Host-b3os_session)
Path Parameters
subscription_id
string
required
path
The subscription ID (`tsub_…`).
Example:
"tsub_01m5t5j75zkh02kbgme7m6vp4d"Responses
200
The trigger subscription.
application/jsonid
string
REQUIRED
object
string
REQUIRED
Enum:
trigger_subscriptionstatus
string
REQUIRED
`active` receives events. `paused` while the routine's triggers are paused (its publishing key was revoked
or expired). `failed` when subscribing at the provider failed; `error` says why and B3OS retries.
Enum:
active, paused, failedroutine_id
string
REQUIRED
version_id
string
REQUIRED
The routine version whose definition created or last updated the subscription.
trigger_id
string
REQUIRED
The trigger's `id` in the routine definition.
trigger
string
REQUIRED
`<namespace>/<name>/<trigger>@<version>` with the exact version (a routine's `@<major>` is resolved and pinned at publish).
pack
string
REQUIRED
`<namespace>/<name>`.
kind
string
REQUIRED
Enum:
webhook, poll, scheduleconfig
object
REQUIRED
The trigger's configuration (the routine trigger's `with`, evaluated at publish); never secret.
connections
object
REQUIRED
Pack connection key to the vault connection bound at publish.
hook_id
string | null
REQUIRED
Webhook triggers, the inbound hook registered with the provider (`POST /v1/actions/hooks/{hook_id}`); otherwise `null`.
last_event_at
string (date-time) | null
REQUIRED
error
object | null
REQUIRED
Why subscribing failed (`status: failed`), or `null`.
type
string (uri)
REQUIRED
`https://docs.beta.b3os.org/errors#<code>`.
title
string
REQUIRED
Short summary of the problem type.
status
integer
REQUIRED
The HTTP status code, repeated for convenience.
code
string
REQUIRED
Stable machine-readable error code from the errors catalog.
detail
string
REQUIRED
Explanation of this occurrence. Never contains secrets.
instance
string
The request ID (`req_…`) of the request that failed. Include it when you contact support.
errors
object[]
Validation problems, one per field (`invalid_request` and the other codes that list `errors`).
Array of:
pointer
string
REQUIRED
Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`,
`#path/<name>` or `#header/<name>` for parameters.
detail
string
REQUIRED
What is wrong there.
reason
string
Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).
required_scope
string
The scope that was missing (`forbidden` with `reason: scope`).
retry_after_s
integer
Same value as the `Retry-After` header, for clients that only read the body.
limit
object
The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.
id
string
REQUIRED
Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.
limit
number
REQUIRED
The limit's value.
unit
string
REQUIRED
What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.
window_s
integer
Window length in seconds for rate limits and quotas.
current
number
Current usage against the limit, when known.
current_status
string
The object's current status, for state conflicts such as `sandbox_not_running`.
upstream_status
integer
The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).
step
string
The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).
pack_error
object
The error a pack's error mapping chose (`upstream_error` from pack actions).
code
string
REQUIRED
message
string
REQUIRED
retryable
boolean
REQUIRED
created_at
string (date-time)
REQUIRED
updated_at
string (date-time)
REQUIRED
400
The request failed validation (`invalid_request`, `invalid_url`).
401
Missing, malformed, expired or revoked credentials (`unauthorized`).
403
Authenticated but not allowed (`forbidden`, `egress_denied`).
404
No such trigger subscription in this project (`trigger_subscription_not_found`).
429
A rate, concurrency or quota limit applies (`rate_limited`, `concurrency_limited`, `quota_exceeded`).
500
Something failed inside B3OS (`internal`). Retry with backoff.
503
The node or the product is not available right now (`node_unavailable`, `product_unavailable`, `capacity_unavailable`).
curl -X GET 'https://beta-api.b3os.org/v1/actions/subscriptions/tsub_01m5t5j75zkh02kbgme7m6vp4d' \ -H 'Authorization: Bearer YOUR_API_TOKEN'const response = await fetch('https://beta-api.b3os.org/v1/actions/subscriptions/tsub_01m5t5j75zkh02kbgme7m6vp4d', { method: 'GET', headers: { "Authorization": "Bearer YOUR_API_TOKEN" }});const data = await response.json();console.log(data);import requestsheaders = { 'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://beta-api.b3os.org/v1/actions/subscriptions/tsub_01m5t5j75zkh02kbgme7m6vp4d', headers=headers)print(response.json())
200
Response
{ "id": "tsub_01m5t5j75zkh02kbgme7m6vp4d", "object": "trigger_subscription", "status": "active", "routine_id": "rtn_01m5t6vhkw4a8fa4tb5w4ffz37", "version_id": "ver_01m5t6ncrsssrysy1p2fbn2pgf", "trigger_id": "invoice_paid", "trigger": "io.b3os/stripe/event@1.0.0", "pack": "io.b3os/stripe", "kind": "webhook", "config": { "types": [ "invoice.paid" ] }, "connections": { "secret_key": "conn_01m5t6cbgdjs1ketgcqwa2sne8" }, "hook_id": "hk_01m5t6qg7cfcq459vcqvpj74jj", "last_event_at": "2026-10-25T21:02:13.200Z", "error": null, "created_at": "2026-10-25T19:20:00.000Z", "updated_at": "2026-10-25T19:20:00.000Z"}API Playground
Try this endpoint
GET
/v1/actions/subscriptions/{subscription_id}