WebhookCreated

webhookIdstringrequired

urlstring<uri>required

Possible values: <= 2048 characters

eventsNoticeKind[]required

Possible values: [credits.low, cap.threshold, cap.reached, payg.escrow_low, payg.escrow_empty, service.halted, service.resumed, renewal.upcoming, renewal.succeeded, renewal.skipped, plan.lapsed, plan.queued_started, deposit.credited, grant.received, grant.expiring, senders.changed, tariff.scheduled, tariff.activated, tariff.cancelled, ru_schedule.scheduled, ru_schedule.activated, tier.status_changed, relayer.draining, incident.opened, incident.updated, incident.resolved, intent.expired_locally, intent.final, api_key.created, api_key.revoked, webhook.disabled, webhook.test, account.suspended]

enabledbooleanrequired

disabledReasonstring | nullnullable

createdAtMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

lastSuccessAtMs(integer | null)<int64>nullable

lastFailureAtMs(integer | null)<int64>nullable

consecutiveFailuresinteger

secretstringrequired

whsec_ + 43 base64url characters. Shown once.

WebhookCreated

{
  "webhookId": "string",
  "url": "string",
  "events": [
    "credits.low"
  ],
  "enabled": true,
  "disabledReason": "string",
  "createdAtMs": 0,
  "lastSuccessAtMs": 0,
  "lastFailureAtMs": 0,
  "consecutiveFailures": 0,
  "secret": "string"
}