WebhookCreatedResponseDto

Example

JSON

{
  "id": "string",
  "scope": "environment",
  "url": "string",
  "event_types": [
    "string"
  ],
  "description": "string",
  "is_active": false,
  "created_at": "2026-04-20T12:00:00.000Z",
  "previous_secret_expires_at": "2026-04-20T12:00:00.000Z",
  "secret": "string"
}

Properties

9 properties 7 required

id string Required

scope enum Required

Enumenvironmentaccount

url string Required

event_types array of string Required

description string Optional

nullable

is_active boolean Required

created_at string Required

format: date-time

previous_secret_expires_at string Optional

While a rotation window is open, when the secret the rotation replaced stops verifying; `null` once only the current secret signs.

format: date-timenullable

secret string Required

HMAC secret — only shown once on creation

Was this page helpful?

Tell us how we can improve this guide.