ImportOS · Docs
API reference

GET /v1/webhooks

List webhook subscriptions

List webhook subscriptions

Subscriptions of the tenant (secrets are never returned). Requires scope write:deals.

  • Authentication: header Authorization: Bearer rv_live_... (API keys and scopes)
  • Required scope: write:deals
Descriptions of the operation, parameters and fields come from the OpenAPI specification (openapi.json).

Responses

200

Subscriptions.

application/json · Schema: WebhookList

FieldTypeRequiredDescription
itemsobject[]yes
items[].idstring (uuid)no
items[].urlstringno
items[].descriptionstring | nullno
items[].eventsstring[]no
items[].enabledbooleanno
items[].secretPrefixstring | nullnoFirst characters of the signing secret, to tell secrets apart. The full secret is never shown again.
items[].failureCountintegerno
items[].lastSuccessAtstring | nullnoISO 8601 date-time (UTC).
items[].lastFailureAtstring | nullnoISO 8601 date-time (UTC).

400

Invalid request parameters or body (code validation_error).

application/problem+json · Schema: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Schema: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Schema: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Schema: Problem

On this page