WebhookSubscriptionWithSecret

  • A webhook subscription plus its plaintext signing secret. Returned only by create and rotate-secret; the secret cannot be retrieved again.

    • dateCreated
      Type: stringFormat: date-time
      required

      When the subscription was created.

    • eventTypes
      Type: array string[]
      required

      Event types this subscription receives.

    • id
      Type: stringFormat: uuid
      required

      Unique identifier of the subscription.

    • signingSecret
      Type: string
      required

      HMAC-SHA256 signing secret (prefixed whsec_). Verify each delivery by computing HMAC-SHA256(secret, timestampHeader + "." + rawBody) and comparing to the signature header. Shown exactly once.

    • status
      Type: stringenum
      required

      active = delivering; paused = suspended by the owner; disabled = auto-disabled by the platform after repeated terminal delivery failures.

      values
      • active
      • paused
      • disabled
    • url
      Type: stringFormat: uri
      required

      Consumer endpoint the signed notification is POSTed to.