Menu · Webhook subscriptions
Webhook subscriptions

List subscriptions

GEThttps://api.ruuster.com/v1/webhooks

Every webhook subscription in your brokerage, with delivery health for the last 24 hours.

  • Authentication: x-api-key and x-email headers of an owner or admin
  • Rate limit: 120 requests per minute per key
View as Markdown

Response

data.subscriptions lists subscription objects; meta.limit is the most your brokerage can have (10).

Subscription object

Field Description
id whk_…
url Where deliveries are sent
events Event kinds, or lead.*
description Your label
status active, paused (by you), disabled (after about 24 hours of failed deliveries) or blocked (by Ruuster)
disabledReason Why it was disabled or blocked
secretHint Last characters of the signing secret. The secret itself is returned only on create and rotate
createdBy, createdAt, updatedAt
health last24h.delivered, last24h.failed, last24h.pending, lastSuccessAt, lastFailureAt, lastError