Portal Audit Logs

Get Portal Audit Log Webhook Status

Changed on

Returns status of the audit log webhook.

get/v3/portals/{portalId}/audit-log-webhook/status

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/audit-log-webhook/status
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

Get response for portal audit log webhook status

webhook_status'active' | 'inactive'

Current status of a webhook. active indicates the webhook is sending or ready to send requests. inactive indicates the webhook has been turned off due to failed attempts.

webhook_enabledboolean

Configured status of a webhook. enabled indicates the client will accept requests. disabled indicates the client will not accept requests.

last_attempt_atstring date-time

The last time a request was made to the webhook, regardless of outcome.

last_response_codeinteger

The last response code received from the webhook.

last_response_messagestring

The last message received from the webhook. Useful for debugging.

Example response

{
  "webhook_status": "active",
  "webhook_enabled": true,
  "last_attempt_at": "2023-03-21T09:29:14.52Z",
  "last_response_code": 401,
  "last_response_message": "Unauthenticated"
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status