Usage Info

This method returns information about a specific webhook key, including its current status, creation date, and activation/deletion timestamps if applicable. Use this method to verify a key's status or retrieve metadata about your webhook encryption keys.

Note that the SharedSecret (encryption key) itself is never returned by this endpoint for security reasons - it is only provided once during key creation via webhook.key.create.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
key_id	string	Yes	The identifier for the webhook key (format: whk_YYYYMMDD_NN).

Example

{
  "key_id": "whk_20251021_01"
}

Response

Data

Parameter	Type	Description
key_id	string	The identifier for the webhook key.
status	string	The current status of the key. Must be one of the WEBHOOK_KEY_STATUSES.
created_at	string	The date-time when the key was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).
activated_at	string	The date-time when the key was activated in ISO 8601 format. Only present if the key has been activated.
deleted_at	string	The date-time when the key was deleted in ISO 8601 format. Only present if the key has been deleted.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_4bMcsHNHiFUpZJqgWplmD",
    "version": "2025-03-24"
  },
  "data": {
    "key_id": "whk_20251021_01",
    "status": "ACTIVE",
    "created_at": "2025-10-21T15:42:33.109Z",
    "activated_at": "2025-10-21T16:30:00.000Z"
  }
}

Example with Deleted Key

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_5cNdtIOIjGVqKLrhXqmnE",
    "version": "2025-03-24"
  },
  "data": {
    "key_id": "whk_20251020_01",
    "status": "DELETED",
    "created_at": "2025-10-20T10:15:00.000Z",
    "activated_at": "2025-10-20T10:20:00.000Z",
    "deleted_at": "2025-10-21T16:30:00.000Z"
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Key ID format is invalid.
ENTITY_NOT_FOUND	400	The `key_id` provided does not exist.