REST API›Organization›Webhook Keys

GET

Returns the current webhook signing settings for an enterprise.

If the enterprise has never changed its settings, the response reflects the platform default: updatedAt is null and status is ENABLED or DISABLED accordingly.

Authorization: Caller must be an admin of the specified enterprise or a member of it.

Path Params

  • enterpriseId string required
    The enterprise ID.

Responses

200
Current webhook signing settings.

Response Body

object

Current webhook signing settings for an enterprise.
  • status string enum required

    Webhook signing status for the enterprise.

    • ENABLED: webhooks are signed.
    • DISABLED: webhooks are not signed.
    • DISABLE_PENDING: a request to disable signing is awaiting approval. Webhooks continue to be signed until the request is approved.
    ENABLEDDISABLEDDISABLE_PENDING
  • signingEnabled boolean required
    Whether webhooks are currently signed. true for ENABLED and DISABLE_PENDING, false for DISABLED.
  • updatedAt string date-time nullable
    When the settings were last changed. null if the enterprise has never changed its settings, in which case status reflects the platform default.
  • pendingDisableRequest object nullable
    Present only when status is DISABLE_PENDING.
    pendingDisableRequest object
    • evaluationId string uuid required
      ID of the policy evaluation that must be approved to complete the disable request.
    • requestedBy string required
      ID of the user who requested that signing be disabled.
    • requestedAt string date-time required
      When the disable request was submitted.
401
Unauthorized

Response Body

object

  • code string
  • message string
  • status integer
403
Forbidden

Response Body

object

  • code string
  • message string
  • status integer
404
The specified resource was not found

Response Body

object

  • code string
  • message string
  • status integer
500
Server Error - Transient error please try again

Response Body

object

  • code string
  • message string
  • status integer