WebhookCreateEnvelope

okbooleanrequired

meta object

watermarkstring

Opaque leak-tracing token. Safe to ignore.

Possible values: Value must match regular expression ^wm_[0-9a-f]{8}$

Example: wm_a1b2c3d4

data object

idstringrequired

urlurirequired

eventsstring[]required

descriptionstring

is_activebooleanrequired

created_atdate-timerequired

revoked_atdate-timenullable

last_delivery_atdate-timenullable

last_delivery_statusintegernullable

delivery_failure_countinteger

signing_secretstringrequired

Shown once. Use as HMAC key when verifying deliveries.

Example: whsec_EXAMPLE_abcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef

warningstringrequired

WebhookCreateEnvelope

{
  "ok": true,
  "meta": {
    "watermark": "wm_a1b2c3d4"
  },
  "data": {
    "id": "string",
    "url": "string",
    "events": [
      "string"
    ],
    "description": "string",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "revoked_at": "2024-07-29T15:51:28.071Z",
    "last_delivery_at": "2024-07-29T15:51:28.071Z",
    "last_delivery_status": 0,
    "delivery_failure_count": 0,
    "signing_secret": "whsec_EXAMPLE_abcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef",
    "warning": "string"
  }
}